Skip to content

Commit 65d1ca8

Browse files
committed
updated docs and readme
1 parent d69d45d commit 65d1ca8

3 files changed

Lines changed: 4 additions & 13 deletions

File tree

‎.readthedocs.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ formats:
2323
# Install Python dependencies required to build your documentation
2424
python:
2525
install:
26-
- requirements: docs/requirements.txt
2726
- method: pip
2827
path: .
2928
extra_requirements:

‎README.md‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,10 @@ For cosmological likelihoods you will need to have [Cobaya](https://cobaya.readt
104104
```python
105105
from BOBE import BOBE
106106

107-
# Initialize BOBE with Cobaya YAML file - CobayaLikelihood created internally
108-
# Initialize BOBE with Cobaya YAML file - CobayaLikelihood created internally
107+
# Initialize BOBE with Cobaya YAML file, prepare it the same way you would for running MCMC/Nested Sampling through Cobaya
109108
sampler = BOBE(
110109
loglikelihood='path/to/cobaya_input.yaml',
111-
likelihood_name='CobayaLikelihood',
112-
n_sobol_init=4,
110+
n_sobol_init=4,
113111
n_cobaya_init=4, # We can also specify reference dists in the Cobaya yaml file to generate additional initial points
114112
likelihood_name='quickstart_cobaya_example', # name for output files
115113
save_dir='./results',
@@ -123,7 +121,7 @@ from BOBE import BOBE
123121
batch_size=5,
124122
fit_n_points=10,
125123
ns_n_points=10,
126-
logz_threshold=0.5,
124+
logz_threshold=0.5, # for higher dimensional examples, can relax the convergence threshold slightly
127125
)
128126

129127
# rest of the run remains the same as above
@@ -160,8 +158,6 @@ If you use BOBE in your research, please cite:
160158

161159
## Troubleshooting
162160

163-
### Installation issues
164-
165161
In case you run into installation issues related to incompatible versions of packages, you can also set up an environment with the exact package versions BOBE was developed and tested with
166162

167163
```bash

‎docs/source/examples/cosmology.rst‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,11 +280,7 @@ For standard ΛCDM with Planck lite:
280280
Expected Runtime
281281
~~~~~~~~~~~~~~~~~~~
282282

283-
For the Planck lite likelihood (each evaluation ~0.5-1 second):
284-
285-
- ~2-5 minutes for ~120 evaluations
286-
287-
Note: Actual likelihood evaluation and total runtime may vary according to your hardware specifications.
283+
For the Planck lite likelihood (each evaluation ~0.5-1 second), this run should take around 2-5 minutes. Note: total runtime may vary according to your hardware specifications.
288284

289285
Running with MPI
290286
~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)