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

1. waper python package
   1. TODO Document a Great Feature
   2. TODO Document another Nice Feature
2. Tested against multiple platforms and python versions

Development

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

1. Test Suite, using pytest, located in tests dir
2. Parallel Execution of Unit Tests, on multiple cpu's
3. Documentation Pages, hosted on readthedocs server, located in docs dir
4. Automation, using tox, driven by single tox.ini file
   1. Code Coverage measuring
   2. Build Command, using the build python package
   3. Pypi Deploy Command, supporting upload to both pypi.org and test.pypi.org servers
   4. Type Check Command, using mypy
   5. Lint Check and Apply commands, using isort and black
5. CI Pipeline, running on Github Actions, defined in .github/
   1. Job Matrix, spanning different platform's and python version's
      1. Platforms: ubuntu-latest, macos-latest
      2. Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10
   2. Parallel Job execution, generated from the matrix, that runs the Test Suite

Prerequisites

You need to have Python installed. The code has been tested only with Python=3.10

You will also need the following packages, all of which must be installed from the conda-forge channel (in a fresh environment preferably)

• geovista (also installs pyvista)
• vtk
• xarray
• networkx
• rasterio
• scikit-learn
• tqdm

Preferably install them all in a single command so that mamba/conda can figure out the optimal way to resolve dependencies.

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