Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Michel Aguena committed Nov 21, 2024
1 parent b774873 commit 38cc55e
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 22 deletions.
38 changes: 19 additions & 19 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@

# Installation instructions

* [Main readme](README.md)
We strongly recommend you make a new conda environment for the installation of CLMM so you can avoid conflicts with versions of
libraries used for other programs.
Here we present several ways to do it.

## Table of contents
1. [Basic installation](#basic_install)
2. [Access to the proper environment on cori.nersc.gov](#access_to_the_proper_environment_on_cori)
3. [An alternative installation at NERSC or at CC-IN2P3 for DESC members](#from_desc_conda_env)
4. [Making a local copy of CLMM](#making_a_local_copy_of_clmm)
2. [Manual installation](#manual_install)
3. [Access to the proper environment on cori.nersc.gov](#access_to_the_proper_environment_on_cori)
4. [An alternative installation at NERSC or at CC-IN2P3 for DESC members](#from_desc_conda_env)
5. [Making a local copy of CLMM](#making_a_local_copy_of_clmm)


## Basic procedure <a name="basic_install"></a>

Here we provide a quick guide for a basic instalation, this will install all the packages in your current environment.
These commands will create a new local environment ready for CLMM installation:

```bash
conda env create -f environment.yml
conda activate clmm
```

You can now install CLMM in a local and stable environment with the usual procedure.

## Manual procedure <a name="basic_install"></a>

Here we provide a quick guide for a maual instalation, this will install all the packages in your current environment.
To create a specific conda environment for CLMM, we recommend you to check the begining of section
[Access to the proper environment on cori.nersc.gov](#access_to_the_proper_environment_on_cori).

Expand Down Expand Up @@ -65,17 +78,6 @@ Now, you can install CLMM and its dependencies as
python setup.py install # build from source
```

### Local environment for CLMM

Alternatively, you can create a new local environment by running

```bash
conda env create -f environment.yml
conda activate clmm
```

You can now install CLMM in a local and stable environment with the usual procedure.

## Access to the proper environment on cori.nersc.gov <a name="access_to_the_proper_environment_on_cori"></a>

If you have access to NERSC, this will likely be the easiest to make sure you have the appropriate environment. After logging into cori.nersc.gov, you will need to execute the following. We recommend executing line-by-line to avoid errors:
Expand Down Expand Up @@ -154,5 +156,3 @@ If you do have edit privileges to CLMM, it may be easier to simply clone the bas
``` bash
git clone [email protected]:LSSTDESC/CLMM.git
```


28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,30 @@ link to this repository: https://github.com/LSSTDESC/CLMM. Please follow the gui

# Installing CLMM <a name="installing"></a>

CLMM can be installed with `pip` or `conda`.
There commands will install most of the dependencies for CLMM,
with the exception of the backend to be used on theoretical predictions,
check [this](#backends) section for details.

For a `pip` installation, run:

```bash
pip install clmm
```

For a `conda` installation, run:

```bash
conda install -c conda-forge clmm
```

We highly recommend you make a new conda environment for the installation of CLMM,
see [INSTALL documentation](INSTALL.md) for instructions on how to do it.

## Requirements <a name="requirements"></a>

CLMM requires Python version 3.8 or later. CLMM has the following dependencies:
CLMM requires Python version 3.8 or later.
CLMM has the following dependencies:

- [NumPy](https://www.numpy.org/) (v1.17 or later)
- [SciPy](https://scipy.org/) (v1.6 or later)
Expand All @@ -32,6 +53,7 @@ CLMM requires Python version 3.8 or later. CLMM has the following dependencies:
```

For the theoretical predictions of the signal, CLMM relies on existing libraries and **at least one of the following must be installed as well**:
<a name="backends"></a>

- [cluster-toolkit](https://cluster-toolkit.readthedocs.io/en/latest/)
- [CCL](https://ccl.readthedocs.io/en/latest/) (versions between 2.7.1.dev10+gf81b59a4 and 3)
Expand All @@ -51,9 +73,9 @@ These are also pip installable:
```
Note, the last item, `sphinx_rtd_theme` is to make the docs.

## Installation <a name="installation"></a>
## Manual installation <a name="installation"></a>

To install CLMM you currently need to build it from source:
To install CLMM manually, you need to build it from source:

```
git clone https://github.com/LSSTDESC/CLMM.git
Expand Down

0 comments on commit 38cc55e

Please sign in to comment.