Skip to content

Commit fd1a0a1

Browse files
add postprocess in readme
1 parent 26c9ebe commit fd1a0a1

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,22 @@ the main branch at the top of this page.
4444
```shell
4545
pip install gw_eccentricity
4646
```
47+
or
48+
```shell
49+
pip install "gw_eccentricity[postprocess]"
50+
```
51+
to additionally install the functionality for postprocessing posterior samples from
52+
parameter estimation pipelines.
4753

4854
## Conda
4955
**gw_eccentricity** can be installed using `conda` also:
5056
```shell
5157
conda install -c conda-forge gw_eccentricity
5258
```
59+
or
60+
```shell
61+
conda install -c conda-forge gw_eccentricity gw_eccentricity-postprocess
62+
```
5363

5464
## From source
5565

@@ -77,7 +87,13 @@ See example notebooks:
7787
* [gw_eccentricity demo](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/gw_eccentricity_demo.ipynb) for how to use the package, along with diagnostic plots.
7888
* [Load waveforms demo](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/load_waveform_demo.ipynb) for loading waveform data into a dictionary format suitable for gw_eccentricity, including for LAL, SXS, and LVCNR waveforms.
7989
- [TEOBResumS-Dali demo](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/egw_from_TEOBResumS-DALI_demo.ipynb) for the same for `TEOBResumS-Dali`.
80-
- [SEOBNRv5EHM demo](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/egw_from_SEOBNRv5EHM_demo.ipynb) for the same for `SEOBNRv5EHM`.
90+
- [SEOBNRv5EHM
91+
demo](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/egw_from_SEOBNRv5EHM_demo.ipynb)
92+
for the same for `SEOBNRv5EHM`.
93+
## Postprocessing posterior samples
94+
See the example notebooks and scripts
95+
[here](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/postprocessing)
96+
for postprocessing posterior from parameter estimation pipelines.
8197

8298
# Making contributions
8399
See this

0 commit comments

Comments
 (0)