Analysis of surface water data.
Project description
hyswap
Project Documentation
hyswap documentation is available at: Link
Installation
User Installation
User installation is possible from source right now. First you will need to clone the repository. Next, from the root of the repository, run the following commands:
pip install -r requirements.txt
pip install .
Developer Installation
Developer installation is possible from source right now. First you will need to clone the repository. Next, from the root of the repository, run the following commands:
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .
Testing and Building Documentation Locally
To test the package locally, run the following command from the root of the repository:
pytest
To build the documentation locally, run the following commands from the root of the repository:
cd docs
make docs
Running the Linting and Formatting Checks Locally
To run the linting and formatting checks locally, run the following commands from the root of the repository:
flake8 .
pydocstringformatter .
Contributing
See the contributing guidelines for more information.
License
See the license for more information.
Disclaimer
See the disclaimer for more information.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
