Metadata-Version: 2.4
Name: psiphy
Version: 0.1.1
Summary: Package for Statistical Inference of Physics — cosmological parameter inference tools
Author-email: Sambit Giri <sambit.giri@astro.su.se>
License: MIT
Project-URL: Homepage, https://github.com/sambit-giri/psiphy
Project-URL: Issues, https://github.com/sambit-giri/psiphy/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: scikit-learn
Requires-Dist: scikit-image
Requires-Dist: getdist
Provides-Extra: mcmc
Requires-Dist: emcee; extra == "mcmc"
Requires-Dist: dynesty; extra == "mcmc"
Requires-Dist: nautilus-sampler; extra == "mcmc"
Provides-Extra: sbi
Requires-Dist: sbi; extra == "sbi"
Requires-Dist: torch; extra == "sbi"
Provides-Extra: hmc
Requires-Dist: blackjax; extra == "hmc"
Requires-Dist: jax; extra == "hmc"
Requires-Dist: jaxlib; extra == "hmc"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: ipykernel; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: psiphy[docs,hmc,mcmc,sbi]; extra == "dev"
Dynamic: license-file

# psiphy — Package for Statistical Inference of Physics

<img src="docs/logo_cropped.png" alt="psiphy logo" width="120" align="right"/>

[![License](https://img.shields.io/github/license/sambit-giri/psiphy.svg)](https://github.com/sambit-giri/psiphy/blob/master/LICENSE)
[![GitHub Repository](https://img.shields.io/github/repo-size/sambit-giri/psiphy)](https://github.com/sambit-giri/psiphy)
[![CI status](https://github.com/sambit-giri/psiphy/actions/workflows/ci.yml/badge.svg)](https://github.com/sambit-giri/psiphy/actions/workflows/ci.yml)
[![Documentation](https://img.shields.io/badge/Documentation-here-blue)](https://sambit-giri.github.io/psiphy)

A Python package for cosmological parameter inference, providing tools for
simulation-based inference (SBI), MCMC sampling, Fisher forecasting, and
posterior diagnostics.

## Installation

Install directly from GitHub:

    pip install git+https://github.com/sambit-giri/psiphy.git

To include optional dependencies (e.g. MCMC samplers):

    pip install "git+https://github.com/sambit-giri/psiphy.git#egg=psiphy[mcmc]"

For a local editable install (recommended for development):

    git clone https://github.com/sambit-giri/psiphy.git
    cd psiphy
    pip install -e ".[dev]"

## Running the tests

The test suite uses [pytest](https://pytest.org). After installing with the `dev` extras:

    pytest tests/ -v

Tests cover package imports, toy model simulators, and sampling utilities. New tests are added alongside each new module.

## Contributing and feedback

Bug reports, feature requests, and questions are welcome — please open an issue on the [GitHub issue tracker](https://github.com/sambit-giri/psiphy/issues). Pull requests are also encouraged.
