CONTRIBUTING.rst

Contributing to OpenET PT-JPL

Thank you for your interest in supporting the OpenET PT-JPL project.

Coding Conventions

OpenET PT-JPL was developed for Python 3.6. The code will likely work on other version of Python 3 but there are no plans to officially support Python 2.7 at this time.

All code should follow the PEP8 style guide.

Docstrings should be written for all functions that follow the NumPy docstring format.

Development

Conda Environment

For local application, development, and testing, the user is strongly encouraged to create a dedicated "openet" conda environment.

Create the conda environment:

conda create --name openet python=3.6

Activate the environment:

conda activate openet

Install additional Python modules using conda (and pip for modules not currently available via conda):

conda install earthengine-api pytest
pip install openet-core --no-deps

Updating OpenET Module

While developing the "ptjpl" module, pip can be used to quickly update the module in the "openet" environment if needed.

pip install . --no-deps

Testing

PyTest

Testing is done using pytest.

python -m pytest

Detailed testing results can be obtained using the "-v" and/or "-s" tags.

python -m pytest -v -s