Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/handley-lab/lsbi

Linear Simulation Based Inference
https://github.com/handley-lab/lsbi

Last synced: about 2 months ago
JSON representation

Linear Simulation Based Inference

Host: GitHub
URL: https://github.com/handley-lab/lsbi
Owner: handley-lab
License: mit
Created: 2023-10-16T15:25:13.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2024-09-29T18:26:07.000Z (3 months ago)
Last Synced: 2024-10-31T13:26:43.416Z (about 2 months ago)
Language: Python
Size: 318 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.rst
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        =======================================

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/

.. image:: https://github.com/handley-lab/lsbi/actions/workflows/unittests.yaml/badge.svg?branch=master

   :target: https://github.com/handley-lab/lsbi/actions/workflows/unittests.yaml?query=branch%3Amaster

   :alt: Unit test status

.. image:: https://github.com/handley-lab/lsbi/actions/workflows/build.yaml/badge.svg?branch=master

   :target: https://github.com/handley-lab/lsbi/actions/workflows/build.yaml?query=branch%3Amaster

   :alt: Build status

.. image:: https://codecov.io/gh/handley-lab/lsbi/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/handley-lab/lsbi

   :alt: Test Coverage Status

.. image:: https://readthedocs.org/projects/lsbi/badge/?version=latest

   :target: https://lsbi.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Status

.. image:: https://badge.fury.io/py/lsbi.svg

   :target: https://badge.fury.io/py/lsbi

   :alt: PyPi location

.. image:: https://anaconda.org/handley-lab/lsbi/badges/version.svg

   :target: https://anaconda.org/handley-lab/lsbi

   :alt: Conda location

.. image:: https://zenodo.org/badge/705730277.svg

   :target: https://zenodo.org/doi/10.5281/zenodo.10009816

   :alt: Permanent DOI for this release

.. image:: https://img.shields.io/badge/license-MIT-blue.svg

   :target: https://github.com/handley-lab/lsbi/blob/master/LICENSE

   :alt: License information

A repository for linear modelling and simulation based inference

UNDER CONSTRUCTION

Features

--------

Installation

------------

``lsbi`` can be installed via pip

.. code:: bash

    pip install lsbi

via conda

.. code:: bash

    conda install -c handley-lab lsbi

or via the github repository

.. code:: bash

    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:

.. code:: bash

    python -m pytest

    black .

    isort --profile black .

    pydocstyle --convention=numpy lsbi

Dependencies

~~~~~~~~~~~~

Basic requirements:

- Python 3.6+

- `anesthetic `__

Documentation:

- `sphinx `__

- `numpydoc `__

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:

.. code:: bash

    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:

.. code:: bash

    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:

.. code:: 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

------------------