Skip to content

Commit daeee01

Browse files
In documentation, added links to GitHub repository. Modified setup.py to work with recent versions of pip (18.0), which now has the wheel module under pip._internal.
1 parent 8bb9430 commit daeee01

File tree

4 files changed

+17
-10
lines changed

4 files changed

+17
-10
lines changed

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. title:: Contents
22

3+
`GitHub repository <https://github.com/heremaps/pptk>`__
4+
35
Contents
46
========
57

docs/source/install.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ Or install from the .whl file that results from
2222
Building from source
2323
----------------------------------------
2424

25-
We provide CMake scripts for automating most of the build process, but ask the
26-
user to manually prepare :ref:`dependencies <requirements>` and record their
25+
pptk source code is available on `GitHub <https://github.com/heremaps/pptk>`__
26+
27+
Build is mostly automated via CMake scripts,
28+
but the user must manually prepare :ref:`dependencies <requirements>` and record their
2729
paths in the following CMake cache variables.
2830

2931
* Numpy_INCLUDE_DIR
@@ -46,8 +48,9 @@ initial cache files, see the CMakeCache..txt files)
4648
Requirements
4749
~~~~~~~~~~~~
4850

49-
Listed are versions of libraries used to develop pptk, though earlier versions
50-
of these libraries may also work.
51+
Listed are versions of libraries used to develop pptk,
52+
though earlier versions of these libraries may also work.
53+
pptk requires 64-bit versions of these libraries.
5154

5255
* `QT <https://www.qt.io/>`_ 5.4
5356
* `TBB <https://www.threadingbuildingblocks.org/>`_ 4.3
@@ -58,6 +61,10 @@ of these libraries may also work.
5861
Windows
5962
~~~~~~~
6063

64+
Check out source code
65+
66+
>>> git clone https://github.com/heremaps/pptk.git <source_folder>
67+
6168
Create an empty build folder
6269

6370
>>> mkdir <build_folder>

docs/source/tutorials/viewer/geolife.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ Extract the zip file and observe the following directory structure.
2626
+-- 181/
2727
2828
The top level :code:`Data/` folder contains 182 user folders, numbered :code:`000/` to :code:`181/`.
29-
Within each user folder, there is a :code:`Trajectory/` folder containing the user's GPS trajectories
30-
(saved as .plt files)
29+
Each user folder has a :code:`Trajectory/` folder containing the user's GPS trajectories (saved as .plt files)
3130
and optionally a :code:`labels.txt` file specifying the mode of transportation employed for a given time interval.
3231

3332
The .plt files look like this.
@@ -142,9 +141,8 @@ Copy the following code into a file named read_geolife.py.
142141
dfs.append(df)
143142
return pd.concat(dfs)
144143
145-
Explanation of the above code
146-
(understanding of the following explanations is not necessary for proceding with the tutorial,
147-
so feel free to skip ahead if you are in a hurry):
144+
Understanding of the following explanation of :file:`read_geolife.py` is not necessary for proceding with the tutorial.
145+
Feel free to skip ahead if you are in a hurry.
148146

149147
- *Lines 1-6* imports required Python packages (use :code:`pip install` for retrieving any missing packages).
150148

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import shutil
77
import platform
88

9-
from pip import wheel
9+
from pip._internal import wheel
1010

1111
wheel_tags = wheel.pep425tags.get_supported()[0]
1212

0 commit comments

Comments
 (0)