Installation#
We recommend working with coincident in an isolated environment, managed by pixi.sh:
Pixi#
Alternatively, you can install the latest development version using the GitHub CLI and :
gh repo clone uw-cryo/coincident
cd coincident
pixi install
pixi shell
Pixi + JupyterLab#
To expose the pixi environment as a “notebook kernel” in JupyterLab, you can
either install JupyterLab into your pixi environment (pixi add jupyterlab) and
lunch jupyterlab from that environment. Or if you are running code on a remote
JupyterHub you can use an extension to expose the pixi environment to JupyterLab
with the pixi-kernel extension.
For example, on the CryoCloud JupyterHub, we
use the following steps to create an environment for running the coincident
example notebooks:
pip install pixi-kernel --user
You will then be able to select the Pixi (Python) kernel from the JupyterLab
interface. You may need to run pixi shell in a terminal before the environment
is available in JupyterLab.
Note
Pixi environments are scoped to folders, so you will only be able to use this environment for notebooks under the coincident/ repository folder.
pip#
The latest release of coincident can be installed from PyPi:
pip install coincident
conda#
We do yet have a conda-forge package for coincident. In the meantime, you can try installing coincident with pip into an existing conda environment, but dependencies are not guaranteed to work:
conda activate myenv
pip install coincident
Or, if possible, install into a clean conda environment:
mamba create -n coincident python=3.12 pip
conda activate coincident
pip install coincident
Authentication#
Some datasets require authentication to search (Maxar) others only require
authentication to download data (NASA). coincident assumes you have the
following Environment Variables defined:
export EARTHDATA_USERNAME=aaaaa
export EARTHDATA_PASSWORD=bbbbb
export MAXAR_API_KEY=ccccc
Sign up for credentials at the following webpages: