Skip to content

Commit c630ec4

Browse files
committed
add contrib
1 parent 1036982 commit c630ec4

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing
1+
## Nested Sampling Book
22

33
This sampling book runs statically, i.e. doesn't rerun the examples
44
```yaml
@@ -9,18 +9,5 @@ execute:
99
This is to reduce dependency management on the assumption that these are generally MWEs that are not strictly managed/checked.
1010
1111
12-
## Contributing guide
13-
14-
- Make an example notebook and run it locally. The visual state of the notebook is copied to the book page.
15-
- Include references to codes / non-standard dependencies as links (see the quickstart example)
16-
- Include bibtex references in the references.bib file and call them in markdown by adding `{cite}`name of ref``
17-
- Add the notebook to the appropriate part of the file tree and track it in git
18-
- Edit the `_toc.yml` file to include the notebook in the table of contents (and hence have it picked up by jupyter book)
19-
- Add yourself to the contributors.md file
20-
- `pip install jupyter-book` to install locally then, run the following to test the page builds
21-
```bash
22-
jb build .
23-
```
24-
2512
2613

intro.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Nested Sampling is a particle Monte Carlo algorithm that has seen widespread usage in the physical sciences. Its popular implementation has often been done in bespoke packages, which hinders wider adoption and generic comparison.
3+
Nested Sampling is a particle Monte Carlo algorithm that has seen widespread usage in the physical sciences. Its popular implementations have often been performed in bespoke packages, which hinders wider adoption and generic comparison.
44

55
The work of {cite}`yallup2025nested` presented the atomic components of the Nested Sampling paradigm in the style of the popular `jax` based sampling library `blackjax`. This has a number of benefits, including:
66
- Compatibility of the atomic components with modern python PPLs such as [numpyro](https://num.pyro.ai/en/latest/index.html#)
@@ -9,7 +9,7 @@ The work of {cite}`yallup2025nested` presented the atomic components of the Nest
99

1010
Following the example of the main `blackjax` library of having a separate pedagogical sampling book, we introduce in these pages the _nested sampling book_, aiming to provide physics motivated use cases focussing on the nested sampling algorithm.
1111

12-
# Installation
12+
## Installation
1313

1414
For now the core library code is available as a fork of blackjax on the handley-lab github (https://github.com/handley-lab/blackjax), specifically the `proposal` branch.
1515

@@ -19,7 +19,7 @@ pip install git+https://github.com/handley-lab/blackjax@proposal
1919

2020
All other non-standard dependencies in the examples contained in this book are listed in the notebooks themselves.
2121

22-
# Citation
22+
## Citation
2323
Usage of the core algorithm should cite both the `blackjax` repo {cite}`cabezas2024blackjax`
2424

2525
```latex
@@ -48,6 +48,10 @@ as well as the pending implementation paper {cite}`yallup2025nested`
4848

4949
Usage of any of the physics examples should follow and include any further relevant citations detailed in the example notebooks.
5050

51+
## Contribution
52+
53+
Contributions are most welcome! Please see the [contribution guidelines](https://github.com/handley-lab/nested-sampling-book/blob/main/CONTRIBUTING.md) for more information. Or start by raising an issue on the book repository https://github.com/handley-lab/nested-sampling-book
54+
5155
```{tableofcontents}
5256
```
5357

0 commit comments

Comments
 (0)