From 38cc55e0ecf1a484b929923c930db2eb53b80d5b Mon Sep 17 00:00:00 2001 From: Michel Aguena Date: Thu, 21 Nov 2024 13:52:01 +0100 Subject: [PATCH] update documentation --- INSTALL.md | 38 +++++++++++++++++++------------------- README.md | 28 +++++++++++++++++++++++++--- 2 files changed, 44 insertions(+), 22 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 1213a338e..4fa1900a0 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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 -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 + +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). @@ -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 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: @@ -154,5 +156,3 @@ If you do have edit privileges to CLMM, it may be easier to simply clone the bas ``` bash git clone git@github.com:LSSTDESC/CLMM.git ``` - - diff --git a/README.md b/README.md index c9a97fd36..dac5bc3c5 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,30 @@ link to this repository: https://github.com/LSSTDESC/CLMM. Please follow the gui # Installing CLMM +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 -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) @@ -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**: + - [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) @@ -51,9 +73,9 @@ These are also pip installable: ``` Note, the last item, `sphinx_rtd_theme` is to make the docs. -## Installation +## Manual installation -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