prettify the bottom of the README, add contributors

JohannesBuchner · May 29, 2024 · 10e1320 · 10e1320
1 parent 653d134
commit 10e1320
Show file tree

Hide file tree

Showing 5 changed files with 124 additions and 537 deletions.
diff --git a/Makefile b/Makefile
@@ -59,15 +59,22 @@ clean-doc:
 	rm -rf docs/build
 	nbstripout docs/*.ipynb
 
-lint: ## check style with flake8
-	flake8 ultranest tests
+SOURCES := $(shell ls ultranest/*.py | grep -Ev '^ultranest/(flatnuts|dychmc|dyhmc|pathsampler).py' | grep -v .pyx.py)
+
+lint: ${SOURCES} ## check style
+	flake8 ${SOURCES}
+	pycodestyle ${SOURCES}
+	pydocstyle ${SOURCES}
 
 test: ## run tests quickly with the default Python
 	PYTHONPATH=. pytest
 
 test-all: ## run tests on every Python version with tox
 	tox
 
+build:
+	$(PYTHON) setup.py build_ext --inplace
+
 coverage: ## check code coverage quickly with the default Python
 	PYTHONPATH=. coverage run --source ultranest -m pytest
 	coverage report -m

diff --git a/README.rst b/README.rst
@@ -114,15 +114,15 @@ Features
 Usage
 ^^^^^
 
-`Get started! <https://johannesbuchner.github.io/UltraNest/using-ultranest.html>`_
+* `Get started! <https://johannesbuchner.github.io/UltraNest/using-ultranest.html>`_
 
 Read the full documentation with tutorials at:
 
-https://johannesbuchner.github.io/UltraNest/
+* https://johannesbuchner.github.io/UltraNest/
 
-`API Reference: <https://johannesbuchner.github.io/UltraNest/ultranest.html#ultranest.integrator.ReactiveNestedSampler>`_.
+* `API Reference: <https://johannesbuchner.github.io/UltraNest/ultranest.html#ultranest.integrator.ReactiveNestedSampler>`_.
 
-`Code repository: https://github.com/JohannesBuchner/UltraNest/ <https://github.com/JohannesBuchner/UltraNest/>`_
+* `Code repository: https://github.com/JohannesBuchner/UltraNest/ <https://github.com/JohannesBuchner/UltraNest/>`_
 
 Licence
 ^^^^^^^
@@ -134,3 +134,21 @@ GPLv3 (see LICENCE file). If you require another license, please contact me.
 The cute hedgehog icon was made by `Freepik <https://www.flaticon.com/authors/freepik>`_.
 It symbolises UltraNest's approach of carefully walking up a likelihood,
 ready to defend against any encountered danger.
+
+Contributors
+^^^^^^^^^^^^
+ * Nicholas Susemiehl
+ * QZ Gao
+ * Sigfried Vanaverbeke
+ * Warrick Ball
+ * Adipol Phosrisom
+ * Alexander Harvey Nitz
+ * Gregory David Martinez
+ * Grigorii Smirnov-Pinchukov
+ * Fabio F Acero
+ * Jacopo Tissino
+ * Benjamin Beauchesne
+ * Kyle Barbary (some ellipsoid code adopted from https://github.com/kbarbary/nestle)
+ * Adam Moss (some architecture and parallelisation adopted from https://github.com/adammoss/nnest)
+ * Josh Speagle (some visualisations adopted from https://github.com/joshspeagle/dynesty/)
+ * Johannes Buchner
diff --git a/docs/example-line.ipynb b/docs/example-line.ipynb
diff --git a/docs/example-warmstart.ipynb b/docs/example-warmstart.ipynb
diff --git a/ultranest/__init__.py b/ultranest/__init__.py
@@ -1,11 +1,5 @@
 # noqa: D400 D205
-"""
-Performs nested sampling to calculate the Bayesian evidence and posterior samples
-
-Some ellipsoid code is adopted from the Nestle library by Kyle Barbary (https://github.com/kbarbary/nestle)
-Some of the architecture and parallelisation is adopted from the nnest library by Adam Moss (https://github.com/adammoss/nnest)
-Some visualisations are adopted from the dynesty library by Josh Speagle (https://github.com/joshspeagle/dynesty/)
-"""
+"""UltraNets performs nested sampling to calculate the Bayesian evidence and posterior samples."""
 
 from .integrator import NestedSampler, ReactiveNestedSampler, read_file
 from .utils import vectorize