Contributing to the Package

Contributing to the Package#

Reporting Issues#

If you uncover a bug or issue with the code, please open an issue through the GitHub site: NOAA-GFDL/xwmt

Developing New Routines#

Pull requests for new routines and code are welcome. Please note that xwmt is in the public domain and licensed and/or copyrighted material is not acceptable.

Creating a development environment#

conda env update -f docs/environment.yml
conda activate docs_env_xwmt
pip install -e .

Locally building the documentation#

conda activate docs_env_xwmt
rm -rf docs/_build
sphinx-build -W -b html docs/source docs/_build/html
Contents