Linear Simulation Based Inference
Project description
- lsbi:
Linear Simulation Based Inference
- Version:
- 0.12.2
- Homepage:
- Documentation:
A repository for linear modelling and simulation based inference
UNDER CONSTRUCTION
Features
Installation
lsbi can be installed via pip
pip install lsbivia conda
conda install -c handley-lab lsbior 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 lsbiDependencies
Basic requirements:
Python 3.6+
Documentation:
Tests:
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 htmland 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.
Adding models and data to the grid. Contact Will Handley to request models or ask for your own to be uploaded.
Questions/Comments
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
