lsbi: Linear Simulation Based Inference

lsbi:: Linear Simulation Based Inference
Author:: Will Handley & David Yallup
Version:: 0.12.3
Homepage:: https://github.com/handley-lab/lsbi
Documentation:: http://lsbi.readthedocs.io/

A repository for linear modelling and simulation based inference

UNDER CONSTRUCTION

Features

Installation

lsbi can be installed via pip

pip install lsbi

via conda

conda install -c handley-lab lsbi

or via the github repository

git clone https://github.com/handley-lab/lsbi
cd lsbi
python -m pip install .

You can check that things are working by running the test suite:

python -m pytest
black .
isort --profile black .
pydocstyle --convention=numpy lsbi

Dependencies

Basic requirements:

Python 3.6+
anesthetic

Documentation:

Tests:

pytest

Documentation

Full Documentation is hosted at ReadTheDocs. To build your own local copy of the documentation you’ll need to install sphinx. You can then run:

python -m pip install ".[all,docs]"
cd docs
make html

and view the documentation by opening docs/build/html/index.html in a browser. To regenerate the automatic RST files run:

sphinx-apidoc -fM -t docs/templates/ -o docs/source/ lsbi/

Citation

If you use lsbi to generate results for a publication, please cite as:

Handley et al, (2024) lsbi: Linear Simulation Based Inference.

or using the BibTeX:

@article{lsbi,
    year  = {2023},
    author = {Will Handley et al},
    title = {lsbi: Linear Simulation Based Inference},
    journal = {In preparation}
}

Contributing

There are many ways you can contribute via the GitHub repository.

You can open an issue to report bugs or to propose new features.
Pull requests are very welcome. Note that if you are going to propose major changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.

Questions/Comments

Metadata

Release files for lsbi 0.12.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lsbi 0.12.3
File	Size	Uploaded
lsbi-0.12.3.tar.gz	19.6 kB	Jul 26, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for lsbi 0.12.3
File	Interpreter	ABI	Platform	Reset
lsbi-0.12.3-py3-none-any.whl 13.7 kB Jul 26, 2024	Python 3	none	any	Details

Total release size: 33.3 kB

Release files / lsbi-0.12.3.tar.gz

Download URL	lsbi-0.12.3.tar.gz
Size	19.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`f788ae2144793af85d029d0aa898a13c4cad9924304ab7fdbfc76815c2a66572`
BLAKE2b-256 checksum How to use checksums	`77215d05e895bf4bef57e1ef48f78843bc3330bd242d80a2b1c2da6aa99a349c`
Upload date	Jul 26, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.4`

Release files / lsbi-0.12.3-py3-none-any.whl

Download URL	lsbi-0.12.3-py3-none-any.whl
Size	13.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4642cf7d2faed5fbc7dcdf8f1e00ad1f223a09d9813ede22d3f7b129106c75c8`
BLAKE2b-256 checksum How to use checksums	`a3fd99b498b3418b9408d91c2db085027573454902f9d566c5356f425ce2f8f3`
Upload date	Jul 26, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.4`