Skip to content

Commit cb040e9

Browse files
authored
DOC add a bit (#117)
1 parent c70366d commit cb040e9

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,25 @@
22

33
[![CircleCI](https://circleci.com/gh/LSSTDESC/firecrown/tree/master.svg?style=svg)](https://circleci.com/gh/LSSTDESC/firecrown/tree/master) [![Documentation Status](https://readthedocs.org/projects/firecrown/badge/?version=latest)](https://firecrown.readthedocs.io/en/latest/?badge=latest)
44

5-
## Installation
5+
## Installation Quickstart
66

7-
You need to have CCL installed first. Try:
7+
The easiest way to get started is conda
88

99
```bash
10-
pip install pyccl
10+
conda install -c conda-forge firecrown
1111
```
1212

13-
Then you can download and install the `master` branch via
13+
## Developer Installation
1414

15-
```
16-
pip install git+https://github.com/LSSTDESC/firecrown.git
17-
```
18-
19-
If you have already cloned the repo, simply install via
15+
To install the package in developer mode, clone the git repo locally and then
16+
use a pip development installation by running
2017

2118
```
2219
pip install -e .
2320
```
2421

22+
from the top-level of the repo.
23+
2524
## Usage
2625

2726
TLDR
@@ -32,7 +31,8 @@ firecrown compute <config file>
3231

3332
will run an example problem.
3433

35-
See the example in the examples folder for more details.
34+
See the examples in the [examples folder](https://github.com/LSSTDESC/firecrown/examples)
35+
for more details.
3636

3737
## Sampling
3838

@@ -48,8 +48,8 @@ or
4848
conda install cosmosis-standalone
4949
```
5050

51-
You may need to specify compilers on install, if your default compilers are not new enough
52-
to support cosmosis, for example, to use non-default GCCs:
51+
You may need to specify compilers when using the pip install, if your default compilers
52+
are not new enough to support cosmosis, for example, to use non-default GCCs:
5353

5454
```bash
5555
FC=gfortran CC=gcc-9 CXX=g++-9 pip install cosmosis-standalone

0 commit comments

Comments
 (0)