Skip to content

Commit

Permalink
added conda installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
arthurmloureiro committed Aug 8, 2024
1 parent 489b904 commit ff86285
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 13 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,29 @@
[![LSST DESC Blinding Slack](https://img.shields.io/badge/join-Slack-4A154B)](https://lsstc.slack.com/archives/CT14ZF2AH)

# Smokescreen: DESC Modules for data concealment (blinding)
This repostory (under development) contains the modules for data concealment (blinding) at the following levels of the analysis:
> :warning: Important notice :warning: : the term "blinding" is used in the context of data concealment for scientific analysis. We understand this is an outdated term and we are working to update it to a more appropriate term. If you have any suggestions, please let us know.
This repository (under development) contains the modules for data concealment (blinding) at the following levels of the analysis:
- Data-vector measurements
- Posterior distribution [not yet developed]
- (TBC) Catalogues

**You can find the documentation for Smokescreen [here](https://lsstdesc.org/Smokescreen/).**

> :warning: Important notice :warning: : the term "blinding" is used in the context of data concealment for scientific analysis. We understand this is an outdated term and we are working to update it to a more appropriate term. If you have any suggestions, please let us know.
## Quick Installation
You can install Smokescreen using conda:
```bash
conda install -c conda-forge lsstdesc-smokescreen
```

For developer installation or other instructions check the [documentation](https://lsstdesc.org/Smokescreen/installation.html).

For questions contact @arthurmloureiro, @jessmuir, or @jablazek

**Legacy Blinding**
> Legacy Blinding scripts for 2pt data vector blinding with Cosmosis moved to a [new repository](https://github.com/LSSTDESC/legacy_blinding).
---

**Legacy 2pt Cosmosis Blinding**

Legacy Blinding scripts for 2pt data vector blinding with Cosmosis moved to a [new repository](https://github.com/LSSTDESC/legacy_blinding).



23 changes: 18 additions & 5 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
Installation
============

Regular Installation
--------------------

.. note::
If you have both `Firecrown <https://github.com/LSSTDESC/firecrown>`_ and `pyccl <https://github.com/LSSTDESC/CCL>`_ installed in your environment, you can skip the installation of the dependencies in the ``environment.yml`` file and simply install ``Smokescreen`` using ``pip``:

.. code-block:: bash
python -m pip install smokescreen
If you do not have *Firecrown* and *pyccl* installed, you can install the dependencies using the instructions below.
If you do not have *Firecrown* and *pyccl* installed, you can install the dependencies using conda:

.. code-block:: bash
conda install -c conda-forge lsstdesc-smokescreen
Developer Installation
-----------------------
If you want to install the package in development mode (or from source to get the latest version), Follow these instructions below.

Creating a new environment:
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can create a new conda environment with the required packages using the `environment.yml` file:

Expand All @@ -26,7 +38,7 @@ This will create a new environment called `desc_smokescreen` with the required p
conda activate desc_smokescreen
Using an existing environment
-----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to install the `Smokescreen` package in an existing environment, you can install it using:

Expand All @@ -38,7 +50,8 @@ If you want to install the `Smokescreen` package in an existing environment, you
After installing the dependencies from `environment.yml`, you can install the `Smokescreen` package using:

Normal Usage Installation
--------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~

After installing the dependencies from ``environment.yml``, you can install the ``Smokescreen`` package using:

.. code-block:: bash
Expand All @@ -50,7 +63,7 @@ The `-e` flag is optional and installs the package in editable mode (useful for
Testing the installation
------------------------

You can test the installation by running the tests:
You can test the developer installation by running the unit tests from the Smokescreen directory:

.. code-block:: bash
Expand Down
3 changes: 1 addition & 2 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: desc_smokescreen
channels:
- conda-forge
dependencies:
- python>=3.9
- python>=3.12
- numpy
- ipykernel
- scipy
Expand All @@ -19,5 +19,4 @@ dependencies:
- flake8
- sacc
#- git+https://github.com/LSSTDESC/firecrown.git@master
- cosmosis
- cosmosis-build-standard-library
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "hatchling.build"
name = "Smokescreen"
description = "Smokescreen: DESC Blinding Unified Library. Based on the Muir et al. (2021) data-vector blinding method."
readme = "README.md"
requires-python = ">=3.9"
requires-python = ">=3.12"
license = {file = "LICENSE"}
maintainers = [
{name = "Arthur Loureiro", email = "arthur.loureiro@fysik.su.se"},
Expand All @@ -21,7 +21,6 @@ dependencies = [
"scipy>=1.9.0",
"astropy>=5.2.0",
"pytest>=7.2.5",
"argparse>=1.0",
"sacc>=0.12",
"pyccl>=3.0.2",
"jsonargparse[signatures]>=4.0",
Expand Down

0 comments on commit ff86285

Please sign in to comment.