sipy 0.3.1

No project description provided

SIpy

SIpy is a fast, lightweight and easily extensible python package for manipulating physical quantities.

For more detailed information read the documentation.

Quickstart

SIpy can be installed via pipenv or pip, and requires Python 3.6.0 or higher.

$ pipenv install sipy
$ pip install sipy

Once SIpy is installed just import the quantities you need and you’re good to go

>>> from sipy import miles, hour
>>> speed_limit = 70 * miles / hour
>>> print(speed_limit)
3.13E+01ms^-1

Contributing

SIpy is developed on GitLab. If you come across an issue, or have a feature request please open an issue. If you want to contribute a fix or feature-implementation please do by proposing a merge request.

Testing

SIpy uses Pytest for unit testing and and pre-commit for static analysis and auto-formatting. Code is automatically checked by Gitlab pipelines when pushed but it is recommended that tests are also run locally.

SIpy used Poetry for managing all external dependencies. Install Poetry using the instructions here and then install dependencies with

$ poetry install

pre-commit should run automatically on every commit. To enable it run

$ poetry run pre-commit install

The unittests can be run with:

$ poetry run pytest --doctest-modules tests sipy README.rst

Help

The SIpy documentation is the best place to start, after that try searching stack overflow, if you still can’t find an answer please open an issue.