Skip to content

Commit

Permalink
In documentation, added links to GitHub repository. Modified setup.py…
Browse files Browse the repository at this point in the history
… to work with recent versions of pip (18.0), which now has the wheel module under pip._internal.
  • Loading branch information
victoriousluser committed Oct 2, 2018
1 parent 8bb9430 commit daeee01
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. title:: Contents

`GitHub repository <https://github.com/heremaps/pptk>`__

Contents
========

Expand Down
15 changes: 11 additions & 4 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ Or install from the .whl file that results from
Building from source
----------------------------------------

We provide CMake scripts for automating most of the build process, but ask the
user to manually prepare :ref:`dependencies <requirements>` and record their
pptk source code is available on `GitHub <https://github.com/heremaps/pptk>`__

Build is mostly automated via CMake scripts,
but the user must manually prepare :ref:`dependencies <requirements>` and record their
paths in the following CMake cache variables.

* Numpy_INCLUDE_DIR
Expand All @@ -46,8 +48,9 @@ initial cache files, see the CMakeCache..txt files)
Requirements
~~~~~~~~~~~~

Listed are versions of libraries used to develop pptk, though earlier versions
of these libraries may also work.
Listed are versions of libraries used to develop pptk,
though earlier versions of these libraries may also work.
pptk requires 64-bit versions of these libraries.

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

Check out source code

>>> git clone https://github.com/heremaps/pptk.git <source_folder>

Create an empty build folder

>>> mkdir <build_folder>
Expand Down
8 changes: 3 additions & 5 deletions docs/source/tutorials/viewer/geolife.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ Extract the zip file and observe the following directory structure.
+-- 181/
The top level :code:`Data/` folder contains 182 user folders, numbered :code:`000/` to :code:`181/`.
Within each user folder, there is a :code:`Trajectory/` folder containing the user's GPS trajectories
(saved as .plt files)
Each user folder has a :code:`Trajectory/` folder containing the user's GPS trajectories (saved as .plt files)
and optionally a :code:`labels.txt` file specifying the mode of transportation employed for a given time interval.

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

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

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import shutil
import platform

from pip import wheel
from pip._internal import wheel

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

Expand Down

0 comments on commit daeee01

Please sign in to comment.