Installation Instructions

Requirements

See PySpeedIT: Required Software.

Installing

Shell-Example

To install from pypi using pip/pip3

$ pip3 install PySpeedIT

To install from source using setup.py

$ python3 setup.py build
$ sudo python3 setup.py install

To install from source using make

$ sudo make install

Note

In the source root folder the Makefile has a number of helpful shortcut commands

Important

Warnings at installation

$ warning: no previously-included files matching '__pycache__' found under directory '*'

This can be ignored __pycache__ is excluded in the MANIFEST.in file

Documentation

The latest copy of this documentation should always be available at: http://packages.python.org/PySpeedIT

If you wish to generate your own copy of the documentation, you will need to:

1. Download the PySpeedIT source.

2. If not already installed - install PSphinxTheme (1.2.4 or better)

   $ pip3 install PSphinxTheme
   

3. From the PySpeedIT source directory, run:

   Shell-Example

   To build the documentation from source using setup.py

   $ python3 setup.py build_sphinx -E
   

   To build from source using make

   $ make docs
   

4. Once Sphinx is finished, point a web browser to the file SOURCE/build/sphinx/html/index.html.