Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.46 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.46 KB
Raw

WaterTAP-REFLO

Welcome to the code repository for WaterTAP-REFLO!

GitHub issues GitHub pull requests CI status

Documentation

WaterTAP-REFLO documentation is available online at https://watertap-reflo.readthedocs.io.

Getting started (for Contributors)

WaterTAP-REFLO supports Python versions 3.8 through 3.10.

Prerequisites

  • The conda package and environment manager, for example by using the Miniconda installer following the steps appropriate for your operating system

Installation

To install WaterTAP-REFLO, run:

git clone https://github.com/watertap-org/watertap-reflo && cd watertap-reflo
conda create --yes --name watertap-reflo-dev python=3.10 && conda activate watertap-reflo-dev
pip install -r requirements-dev.txt

Running tests

conda activate watertap-reflo-dev
pytest --pyargs watertap_contrib.reflo

Formatting code

Before committing, the Python code must be formatted with Black.

Black is installed by default as part of the developer dependencies. To format the code, run the following command from the local repository root directory:

conda activate watertap-reflo-dev
black .