Skip to content

Commit

Permalink
prepare release
Browse files Browse the repository at this point in the history
* update citation
* update contribution guidelines
* bump version
  • Loading branch information
janfb committed Jul 28, 2023
1 parent 8769e25 commit 7c826a9
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 5 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ head over to [issues on GitHub](https://github.com/mackelab/sbi/issues).

## Code contributions

Contributions to the `sbi` are very welcome!
In general, we use pull requests to make changes to `sbi`. So, if you are planning to
make a contribution, please fork, create a feature branch and then make a PR from
your feature branch to the upstream `sbi` ([details](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
To give credits to contributions, at the end of every year, we consider adding contributors who repeatedly and substantially contributed to `sbi` to the list of authors of the package.
Additionally, we mention all contributors in the releases.

### Development environment

Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ M. Durkan's `lfi`. `sbi` runs as a community project; development is coordinated

## Citation

If you use `sbi` consider citing the [sbi software paper](https://doi.org/10.21105/joss.02505), in addition to the original research articles describing the specific sbi-algorithm(s) you are using:
If you use `sbi` consider citing the [sbi software paper](https://doi.org/10.21105/joss.02505), in addition to the original research articles describing the specific sbi-algorithm(s) you are using.

```
```latex
@article{tejero-cantero2020sbi,
doi = {10.21105/joss.02505},
url = {https://doi.org/10.21105/joss.02505},
Expand All @@ -123,3 +123,6 @@ If you use `sbi` consider citing the [sbi software paper](https://doi.org/10.211
journal = {Journal of Open Source Software}
}
```

The above citation refers to the original version of the `sbi` project and has a persistent DOI.
Additionally, new releases of `sbi` are citable via [Zenodo](https://zenodo.org/record/3993098), where we create a new DOI for every release.
7 changes: 5 additions & 2 deletions docs/docs/citation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Citation

If you use `sbi` consider citing the [corresponding paper](https://doi.org/10.21105/joss.02505):
If you use `sbi` consider citing the [sbi software paper](https://doi.org/10.21105/joss.02505), in addition to the original research articles describing the specific sbi-algorithm(s) you are using.

```
```latex
@article{tejero-cantero2020sbi,
doi = {10.21105/joss.02505},
url = {https://doi.org/10.21105/joss.02505},
Expand All @@ -16,3 +16,6 @@ If you use `sbi` consider citing the [corresponding paper](https://doi.org/10.21
journal = {Journal of Open Source Software}
}
```

The above citation refers to the original version of the `sbi` project and has a persistent DOI.
Additionally, new releases of `sbi` are citable via [Zenodo](https://zenodo.org/record/3993098), where we create a new DOI for every release.
2 changes: 1 addition & 1 deletion sbi/__version__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of sbi, a toolkit for simulation-based inference. sbi is licensed
# under the Affero General Public License v3, see <https://www.gnu.org/licenses/>.

VERSION = (0, 21, 0)
VERSION = (0, 22, 0)

__version__ = ".".join(map(str, VERSION))
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
"bayesian parameter inference system_identification simulator PyTorch"
)
URL = "https://github.com/mackelab/sbi"
# TODO: update email to new organization email.
EMAIL = "[email protected]"
# TODO: Update author list?
AUTHOR = """Álvaro Tejero-Cantero, Jakob H. Macke, Jan-Matthis Lückmann, Conor M.
Durkan, Michael Deistler, Jan Bölts"""
REQUIRES_PYTHON = ">=3.6.0"
Expand Down Expand Up @@ -150,6 +152,7 @@ def run(self):
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Scientific/Engineering :: Mathematics",
# TODO: Update python support?
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
Expand Down

0 comments on commit 7c826a9

Please sign in to comment.