Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 1.58 KB

CONTRIBUTING.rst

File metadata and controls

66 lines (38 loc) · 1.58 KB
Raw

Contributing to OpenET

Thank you for your interest in supporting the OpenET project.

Versioning

The OpenET project is currently in Beta and the version numbers will be "0.0.X" until a non-Beta release is made.

Coding Conventions

OpenET 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 use the "openet" conda environment defined in the provided environment.yml.

Create the conda environment:

conda env create -f environment.yml

Activate the environment:

conda activate openet

Updating OpenET Module

While developing the "openet-core" 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