Scientific Python package for Simulation Output Analysis
A Scientific Python package for Simulation Output Analysis
Read the Docs: readthedocs.org/projects/pysimoa
Requirements and Python 2/3 compatibility
This package runs under Python 2 and Python 3, and has been tested with Python 2.7.6 and Python 3.4.0.
See the LICENSE file.
To set up a Python 2.7 environment in .devenv27, run:
$ tox -e devenv27
To set up a Python 3.4 environment in .devenv34, run:
$ tox -e devenv34
This package uses setuptools.
$ python setup.py sdist
$ python setup.py bdist
$ python setup.py bdist_wheel
to build a source, binary or wheel distribution.
Complete Git Integration
Setuptool uses the information of tags to infer the version of your project with the help of versioneer.
To use this feature you need to tag with the format MAJOR.MINOR[.REVISION] , e.g. v0.0.1 or v0.1. The prefix v is needed!
$ python setup.py version
to retrieve the current PEP440-compliant version. This version will be used when building a package and is also accessible through devs.__version__. The version will be unknown until you have added a first tag.
Unleash the power of Git by using its pre-commit hooks.
$ pre-commit install
to install the pre-commit hooks.
Build the documentation with
$ python setup.py docs
and run doctests with
$ python setup.py doctest
$ tox -e docs
Add further options separated from tox options by a double dash --:
$ tox -e docs -- --help
Continuous documentation building
For continuously building the documentation during development, run:
$ python setup.py autodocs
Unittest & Coverage
$ python setup.py test
The py.test plugin pytest-cov is used to automatically generate a coverage report.
For continuous testing in a Python 2.7 environment, run:
$ python2 setup.py test --tox-args='-c toxdev.ini -e py27'
For continuous testing in a Python 3.4 environment, run:
$ python3 setup.py test --tox-args='-c toxdev.ini -e py34'
A CiteULike group manages the bibliography.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.