Requirements¶
It is advised to use setuptools via the provided setup.py file for pulling in the required dependencies. The dependencies for building the documentation and running the test coverage analysis, two requirements files to be passed to pip install -r are provided: test_requirements.txt and docu_requirements.txt.
- Python (obviously, >= 3.3)
- PyPinT has been tested with Python version 3.3.x and 3.4.0. Python 3.2 does not have unittest.mock included [1] and do not support Unicode literals of the form u'text (cf. PEP414), which is used by Logbook, thus Python 3.2 is not supported. All 2.x versions are known to not be compatible. This is on purpose. [2]
- enum34 (required if Python < 3.4)
- Enumeration types have been introduced by Python 3.4 and are backported as this package.
- NumPy (required, >= 1.6.1)
- Required for its arrays
- SciPy (required, >= 0.9.0)
- Required for its linear algebra module
- matplotlib (required, >= 1.2.0)
- Required for the plotters
- configobj (required, >=5.0.2)
- Required for dealing with configuration files
- Logbook (required, >= 0.6.0)
- The logging output is handeled via LogBook.
- Sphinx (optional, >= 1.3a0)
Required to generate the documentation. See Documentation for further details.
- sphinx-rtd-theme (required)
- Required for the layout and look of the generated HTML documentation.
- nose (optional, >= 1.3.1)
Required for running the unit test suite. See Testing for further details.
- coverage (strongly suggested)
- For test coverage analysis.
- nose-cover3 (required if coverage is installed)
- Plugin for nose to generate test coverage.
Footnotes
[1] | https://docs.python.org/3.3/library/unittest.mock.html#module-unittest.mock |
[2] | Blame your system’s administrator in case you don’t have any Python 3 available. |