eo-tides 0.6.3.dev5__tar.gz → 0.6.3.dev6__tar.gz

{eo_tides-0.6.3.dev5 → eo_tides-0.6.3.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.3.dev5
+Version: 0.6.3.dev6
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
 Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides

eo_tides-0.6.3.dev6/docs/install.md

@@ -0,0 +1,136 @@
+# Installing `eo-tides`
+
+## Stable version
+
+The latest stable release of `eo-tides` is:
+
+[![PyPI](https://img.shields.io/pypi/v/eo-tides)](https://pypi.org/project/eo-tides/)
+
+It is compatible with the following Python versions:
+
+[![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
+
+`eo-tides` can be installed into your Python environment using either `pip` (the standard Python package manager), or `uv` ([a fast Python package manager](https://docs.astral.sh/uv/) written in Rust).
+
+!!! tip
+
+    We recommend installing with `uv` as this makes it easy to set up an isolated environment containing compatible Python packages.
+
+=== "Installing with `pip`"
+
+    Install `eo-tides` with essential package dependencies only:
+    ```console
+    python3 -m pip install eo-tides
+    ```
+
+    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
+
+    ```console
+    python3 -m pip install eo-tides[notebooks]
+    ```
+
+=== "Installing with `uv`"
+
+    First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
+
+    Create a new virtual environment:
+    ```console
+    uv venv
+    ```
+
+    Activate your virtual environment:
+    ```console
+    source .venv/bin/activate
+    ```
+
+    Install `eo-tides` into your virtual environment, with essential package dependencies only:
+    ```console
+    uv pip install eo-tides
+    ```
+
+    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
+
+    ```console
+    uv pip install eo-tides[notebooks]
+    ```
+
+## Unstable development pre-releases
+
+Unstable development pre-releases of `eo-tides` are also available:
+
+[![PyPI](https://img.shields.io/badge/pypi-releases-f48041)](https://pypi.org/project/eo-tides/#history)
+
+=== "Installing with `pip`"
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    ```console
+    python3 -m pip install eo-tides==0.6.3.dev5
+    ```
+
+=== "Installing with `uv`"
+
+    First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
+
+    Create a new virtual environment:
+    ```console
+    uv venv
+    ```
+
+    Activate your virtual environment:
+    ```console
+    source .venv/bin/activate
+    ```
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    ```console
+    uv pip install eo-tides==0.6.3.dev5
+    ```
+
+!!! important
+
+    Unstable development pre-releases may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.
+
+### Advanced: Developing locally
+
+To work on `eo-tides` locally, we recommend using `uv`.
+
+First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/).
+
+Clone the `eo-tides` repository:
+
+```console
+git clone https://github.com/GeoscienceAustralia/eo-tides
+cd eo-tides/
+```
+
+Use `uv sync` to populate an environment with package dependencies from the `eo-tides` [lockfile](https://github.com/GeoscienceAustralia/eo-tides/blob/main/uv.lock):
+
+```console
+uv sync --all-extras
+```
+
+Set up pre-commit hooks:
+
+```console
+uv run pre-commit install
+```
+
+We provide a [pre-prepared Makefile](https://github.com/GeoscienceAustralia/eo-tides/blob/main/Makefile) that you can use to easily run common tasks:
+
+```console
+# Run code quality checks
+make check
+
+# Run pytest tests
+make test
+
+# Run Jupyter notebook tests
+make test-notebooks
+
+# Build and preview documentation
+make docs
+```
+
+## Next steps
+
+Once you have installed `eo-tides`, you will need to [download and set up at least one tide model](setup.md) before you can model tides.

{eo_tides-0.6.3.dev5 → eo_tides-0.6.3.dev6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.6.3.dev5"
+version = "0.6.3.dev6"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [
     { name = "Robbi Bishop-Taylor" },

eo_tides-0.6.3.dev5/docs/install.md

@@ -1,49 +0,0 @@
-# Installing `eo-tides`
-
-## Stable version
-
-[![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
-[![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
-
-The [latest stable release](https://pypi.org/project/eo-tides/) of `eo-tides` can be installed into your Python environment from [PyPI](https://pypi.org/project/eo-tides/) using `pip`:
-
-```console
-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:
-
-```console
-python3 -m pip install eo-tides[notebooks]
-```
-
-## Unstable development version
-
-To install the latest unstable development version of `eo-tides` directly from Github, run:
-
-```console
-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:
-
-```console
-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:
-
-```console
-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](setup.md) before you can model tides.