Before installation, you may want to create a new conda environment. If you do, see instructions here.
GCRCatalogs is available on conda-forge, not on conda’s “defaults” channel.
If you are using the “defaults” channel (for example, if you haven’t heard of conda-forge),
you can still install
GCRCatalogs directly using the instruction below.
However, please consider switching to the conda-forge channel;
NOTE: In order to access the latest catalogs (as of June 2021) you need
version v1.3.3 or later. When using either of the install methods described below you will get a suitable released version. If you have already installed
GCRCatalogs for an earlier
data release, you can update instead.
GCRCatalogs with conda, run
conda install -c conda-forge lsstdesc-gcr-catalogs
To update with conda, run
conda update -c conda-forge lsstdesc-gcr-catalogs
Before installation, you may want to create a new virtual environment. If you do, see instructions here.
You may want to first install
which will allow pip to fetch pre-built binary files.
pip install wheel # optional
GCRCatalogs with pip, run
pip install https://github.com/LSSTDESC/gcr-catalogs/archive/v1.3.3.tar.gz#egg=GCRCatalogs[full]
To update with pip, use the
pip install --upgrade https://github.com/LSSTDESC/gcr-catalogs/archive/v1.3.3.tar.gz#egg=GCRCatalogs[full]
When you used Globus transfer, if you downloaded the files to
/path/to/the/download/directory, then run in a terminal
python -m GCRCatalogs.user_config set root_dir /path/to/the/download/directory
/path/to/the/download/directory should contain the
lsstdesc-public folder that Globus transfer creates.
If you have moved it, you should change
/path/to/the/download/directory to the directory that contains the
Do not change the directory structure within
You only need to set this once.
You can use the following Python code to check if you have
GCRCatalogs installed and
root_dir correctly set.
import GCRCatalogs GCRCatalogs.get_root_dir()
To see the list of public catalogs that may be available to you, run:
Note that the above function returns the list of public catalogs that DESC has published, but it does not check if those catalog files exist on your machine. You will need to download them manually following these instructions.