A collection of routines for various tasks related to the sea-ice laboratory of the Max-Planck-Institute for Meteorology in Hamburg
The simplest way to install the package is via pip:
pip install git+https://github.com/markusritschel/mpim-icelab.gitFor any future updates simply rerun the command again.
However, one can also install from the sources (with the option to update via a simple git pull):
Therefore, clone this repo via
git clone https://github.com/markusritschel/mpim-icelabThen, in the new directory (cd mpim-icelab/) install the package via:
python setup.py install
If you intend to perform changes on the source code, then an installation by using one of the following commands is suggested:
python setup.py develop
pip install -e .
This reflects any changes in the source code directly in the installed instance without the need of updating the installation.
For some examples of usage, have a look at the Jupyter notebooks in the notebooks directory. They explain some of the package's functionalities.
To test the code, run make test in the source directory.
This will execute both the unit tests and docstring examples (using pytest).
Run make coverage to generate a test coverage report and make lint to check code style consistency.
- Add examples in Jupyter Notebook for TSTICKS
For any questions or issues, please contact me via [email protected] or open an issue.
© Markus Ritschel 2020