install.md

Installing eo-tides

Stable version

The latest stable release of eo-tides can be installed into your Python environment from PyPI using pip:

python3 -m pip install eo-tides

By default, only essential package dependencies are installed. To install all packages required for running the included Jupyter Notebook examples (including odc-stac and pystac-client for loading freely available satellite data), run:

python3 -m pip install eo-tides[notebooks]

Unstable development version

To install the latest unstable development version of eo-tides directly from Github, run:

python3 -m pip install git+https://github.com/GeoscienceAustralia/eo-tides.git

!!! important

Unstable development versions of `eo-tides` may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.

Cloning locally

To clone the eo-tides repository locally:

git clone https://github.com/GeoscienceAustralia/eo-tides.git

Navigate to the project directory and install in editable mode from your local copy of the repository:

cd eo-tides
python3 -m pip install -e .

Next steps

Once you have installed eo-tides, you will need to download and set up at least one tide model before you can model tides.