Skip to content

Commit

Permalink
add installation instructions to readme! [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunsavel committed Mar 12, 2024
1 parent 122e45b commit 1a77a01
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,30 @@ A Python package for decreasing the memory footprint of opacity functions. The p
- neural network fitting


All fits are currently made in along the temperature and pressure axes.
All fits are currently made in along the temperature and pressure axes.

Additionally, `cortecs` can chunk up opacity functions. The radiative transfer problem can often be cast as embarassingly parallel, so each chunk can be sent to a different CPU.


Installation instructions
-------------------------
`cortecs` can be installed via pip:
```bash
pip install cortecs
```

or conda:
```bash
conda install -c conda-forge cortecs
```

or from source:
```bash
git clone
cd cortecs
pip install -e .
```
To install from source with optional neural network support:
```bash
pip install -e .[neural_networks]
```

0 comments on commit 1a77a01

Please sign in to comment.