waper 0.0.1

Description:

waper 0.0.1

Waper
A rossby Wave Packet trackER
.. start-badges






Code: https://github.com/JoyMonteiro/waper
Docs: https://waper.readthedocs.io/en/master/
PyPI: https://pypi.org/project/waper/
CI: https://github.com/JoyMonteiro/waper/actions/


Features

waper python package

TODO Document a Great Feature
TODO Document another Nice Feature


Tested against multiple platforms and python versions


Development
Here are some useful notes related to doing development on this project.

Test Suite, using pytest, located in tests dir
Parallel Execution of Unit Tests, on multiple cpu’s
Documentation Pages, hosted on readthedocs server, located in docs dir
Automation, using tox, driven by single tox.ini file

Code Coverage measuring
Build Command, using the build python package
Pypi Deploy Command, supporting upload to both pypi.org and test.pypi.org servers
Type Check Command, using mypy
Lint Check and Apply commands, using isort and black


CI Pipeline, running on Github Actions, defined in .github/

Job Matrix, spanning different platform’s and python version’s

Platforms: ubuntu-latest, macos-latest
Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10


Parallel Job execution, generated from the matrix, that runs the Test Suite






Prerequisites
You need to have Python installed.


Quickstart
Using pip is the approved way for installing waper.
python3 -m pip install waper
TODO Document a use case


License


BSD 3-Clause License



License

Free software: BSD 3-Clause License