Skip to content

Installation

HyperCoast requires Python 3.11 or newer.

Install using uv

uv is an extremely fast Python package and project manager, written in Rust. Follow the instructions on the uv website to install uv on your computer. Once uv is installed, you can install hypercoast using the following command:

1
2
uv venv
uv pip install hypercoast jupyterlab

To run JupyterLab, use the following command:

1
uv run jupyter lab

Install from PyPI

hypercoast is available on PyPI. To install hypercoast, run this command in your terminal:

1
pip install hypercoast

HyperCoast groups optional dependencies by feature area:

  • core: local NetCDF/HDF and xarray workflows.
  • viz: maps, plotting, PyVista, and raster visualization.
  • cloud: NASA Earthdata and cloud storage helpers.
  • qgis: QGIS plugin runtime helpers.
  • ml: optional MoE/VAE machine-learning workflows.
  • docs: documentation build tools.

To install all optional dependencies all at once, run the following command:

1
pip install "hypercoast[all]"

For a smaller install, choose only the extras you need, for example:

1
2
pip install "hypercoast[core,cloud]"
pip install "hypercoast[viz,ml]"

Install from conda-forge

hypercoast is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can install hypercoast using the following command:

1
conda install -c conda-forge hypercoast

Alternatively, you can create a new conda environment and install hypercoast in the new environment. This is a good practice because it avoids potential conflicts with other packages installed in your base environment.

1
2
3
4
conda install -n base mamba -c conda-forge
conda create -n hyper python=3.11
conda activate hyper
mamba install -c conda-forge hypercoast

To install the optional dependencies, run the following command:

1
mamba install -c conda-forge cartopy earthaccess mapclassify pyvista trame-vtk trame-vuetify

Install from GitHub

To install the development version from GitHub using Git, run the following command in your terminal:

1
pip install git+https://github.com/opengeos/hypercoast