Installation#

Pixi (recommended)#

We recommend working with coincident in an isolated environment, with specific versions of dependencies managed by pixi.sh:

gh repo clone uw-cryo/coincident
cd coincident

export PIXI_FROZEN=true
pixi install
pixi shell # type "exit" to deactivate environment

Executing Jupyter Notebooks#

You can run and modify coincident example notebooks (in the docs/examples/ folder) using your editor of choice. VSCode automatically detects pixi environments, but JupyterLab requires the pixi-kernel extension.

Local workstations#

If working on your personal computer it can be convenient to install a global jupyterlab executable that can be used with any pixi environment:

pixi global install --environment jupyterlab jupyterlab jupyterlab-myst pixi-kernel

Remote workstations#

If you’re using a remote JupyterHub, like CryoCloud JupyterHub, use the following command to create an environment for running the coincident example notebooks (you only need to run this once):

pip install pixi-kernel --user

You will then be able to select the Pixi (Python) kernel from the JupyterLab interface. Note that 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 install (not recommended)#

The latest release of coincident can be installed from PyPi, but this is not recommended because exact dependency versions are not guaranteed.

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 pip
conda activate coincident
pip install coincident

Authentication#

Some datasets require authentication to search (Vantor) others only require authentication to download data (NASA). coincident assumes you have the following Environment Variables defined:

export VANTOR_API_KEY=ccccc
export EARTHDATA_TOKEN=aaaaa

Sign up for credentials at the following webpages: