lsstdesc-crow 1.0.10

Cluster Reconstruction of Observables Workbench

CROW

Cluster Reconstruction of Observables Workbench: CROW

The LSST-DESC Cluster Reconstruction of Observables Workbench (CROW) code is a DESC tool consisting of a Python library for predicting galaxy cluster observabless. The code documentation can be found at https://lsstdesc.org/crow/.

Table of contents

1. Installing CROW
2. Using CROW
3. Contributing to CROW
4. Contact

Installing Crow

Crow can be installed with pip or conda.

For a pip installation, run:

pip install lsstdesc-crow

For a conda installation, run:

conda install -c conda-forge lsstdesc-crow

After, to use is in your code, just do

import crow

Requirements

Crow requires Python version 3.11 or later.

Dependencies

Crow has the following dependencies:

• NumPy (v2 or later)
• SciPy (v1.12 or later)
• Pyccl
• CLMM

Optional Dependencies

• NumCosmo — required only for the NumCosmoIntegrator. If not installed, all other functionality remains available. NumCosmo is only available via conda, not pip:

  conda install -c conda-forge numcosmo

Using Crow

This code has been released by DESC, although it is still under active development. You are welcome to re-use the code, which is open source and available under terms consistent with our LICENSE (BSD 3-Clause).

Example usage can be found in the notebooks folder.

DESC Projects: External contributors and DESC members wishing to use Crow for DESC projects should consult with the DESC Clusters analysis working group (CL WG) conveners, ideally before the work has started, but definitely before any publication or posting of the work to the arXiv.

Non-DESC Projects by DESC members: If you are in the DESC community, but planning to use Crow in a non-DESC project, it would be good practice to contact the CL WG co-conveners and/or the Crow Team leads as well (see Contact section). A desired outcome would be for your non-DESC project concept and progress to be presented to the working group, so working group members can help co-identify tools and/or ongoing development that might mutually benefit your non-DESC project and ongoing DESC projects.

External Projects by Non-DESC members: If you are not from the DESC community, you are also welcome to contact Crow Team leads to introduce your project and share feedback.

Contributing to Crow

You are welcome to contribute to the code. To do so, please make sure you use isort and black on your code and assure you provide unit tests.

Updating Public Documentation on lsstdesc.org

This is easy! Once you have merged all approved changes into main, you will want to update the public documentation. Just go to the publish-docs branch (git checkout publish-docs) and run the ./publish_docs script.

Contact

If you have comments, questions, or feedback, please contact the current leads of the LSST DESC Crow Team: Michel Aguena (m-aguena, [e-mail]) and Eduardo Barroso (eduardojsbarroso, [e-mail])