Skip to main content

Scientific Python package for Simulation Output Analysis

Project description


A Scientific Python package for Simulation Output Analysis

.. image::
:alt: Documentation Status

.. image::
:alt: License

* **Documentation**: ` <>`_
* **Repository**: ` <>`_
* **Read the Docs**: ` <>`_
* **Bibliography**: ` <>`_

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 <LICENSE>`_ file.


Development environment

Use `tox`_ to `prepare virtual environments for development`_.

.. _prepare virtual environments for development:

.. _tox:

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`_.

.. _setuptools:

Run ::

$ python sdist

or ::

$ python bdist

or ::

$ python 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!

Run ::

$ python 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.

.. _PEP440:

Pre-commit hooks

Unleash the power of Git by using its `pre-commit hooks

Run ::

$ pre-commit install

to install the pre-commit hooks.

Sphinx Documentation

Build the documentation with ::

$ python docs

and run doctests with ::

$ python doctest

Alternatively, let `tox`_
`configure the virtual environment and run sphinx <>`_::

$ tox -e docs

Add further options separated from tox options by a double dash ``--``::

$ tox -e docs -- --help

`Read the Docs`_ hosts the project at

.. _Read the Docs:

Add `requirements`_ for building the documentation to the
`requirements-doc.txt <requirements-doc.txt>`_ file.

.. _requirements:

Continuous documentation building

For continuously building the documentation during development, run::

$ python autodocs

Unittest & Coverage

Run ::

$ python test

to run all unittests defined in the subfolder ``tests`` with the help of `tox`_
and `py.test`_.

.. _py.test:

The py.test plugin `pytest-cov`_ is used to automatically generate a coverage

.. _pytest-cov:

Continuous testing

For continuous testing in a **Python 2.7** environment, run::

$ python2 test --tox-args='-c toxdev.ini -e py27'

For continuous testing in a **Python 3.4** environment, run::

$ python3 test --tox-args='-c toxdev.ini -e py34'

Requirements Management

Add `requirements`_ to the `requirements.txt <requirements.txt>`_ file which
will be automatically used by ````.


A `CiteULike group`_ manages the bibliography.

.. _CiteULike group:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (29.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page