Installation

Default installation

To use tidesurf, we recommend installing it in a fresh virtual environment with Python version \(\geq\) 3.10. You can set up the environment as follows (for Python 3.12):

conda create -n <env_name> python=3.12
conda activate <env_name>

PyPI

You can install the package from PyPI:

pip install tidesurf

GitHub

To install the latest development version, clone the repository from GitHub:

git clone git@github.com:janschleicher/tidesurf.git

Change into the directory and install with pip:

cd tidesurf
pip install -e .

Contributing

To install the development version for contributing to the project, you need to install the optional dependencies ruff and pytest. They are used for code formatting and testing, respectively, and should be run before committing changes.

pip install -e ".[dev]"