trilobite 1.0.0a1

.. image:: https://raw.githubusercontent.com/TransientsExtragalactic/Trilobite/main/docs/source/images/logo.svg
:width: 260px
:align: center
:alt: Trilobite

|Tests| |docs| |docs-stable| |RUFF| |PRE-COMMIT| |ISORT| |NUMPYDOC| |DOCFORMATTER| |COMMITIZEN| |CONVENTIONAL-COMMITS| |ASTROPY| |CONTRIBUTORS| |LAST-COMMIT|

----

The **TR**\ansient **I**\nference **L**\ibrary for **O**\bservation, **B**\ayesian **I**\nference, and **T**\ime-domain **E**\xploration
(**TRILOBITE**) is a powerful, modular computational
library for modeling the interaction of transient astrophysical outflows with their surrounding environments.

TRILOBITE bridges the gap between theory and observation by combining shock dynamics, microphysical
prescriptions, and radiative transfer into a unified framework — enabling rapid-deployment modeling of
**GRBs, TDEs, supernovae**, and other astrophysical transients.


Overview
========

**What can it do?**

- **Customizable transient models** — Pre-built models for GRBs, TDEs, and supernovae, fully configurable for your science case.
- **Modular physics components** — Mix-and-match dynamics, radiation, and opacity modules to build novel transient models from scratch.
- **Flexible Bayesian inference** — End-to-end parameter estimation pipelines for fitting models to radio and multi-wavelength data.
- **Ecosystem integration** — Native compatibility with ``astropy``, ``emcee``, and modern radio data formats.

**Who is it for?**

- Researchers modeling transient shock physics and radio emission
- Scientists building custom astrophysical forward models
- Observers looking to constrain explosion parameters from data

----

Quick Install
=============

Install from PyPI:

.. code-block:: bash

pip install trilobite

Install from source:

.. code-block:: bash

git clone https://github.com/TransientsExtragalactic/Trilobite
cd Trilobite
pip install -e .

For full setup instructions, see the
`Installation Guide <https://transientsextragalactic.github.io/Trilobite/getting_started/installation.html>`_.

----

Documentation
=============

The full documentation — user guides, API references, worked examples, and theory background — is available at:

`https://transientsextragalactic.github.io/Trilobite <https://transientsextragalactic.github.io/Trilobite>`_

----

Contributing
============

Development takes place on
`GitHub <https://github.com/TransientsExtragalactic/Trilobite>`_.

Bug reports, feature requests, and documentation improvements are welcome via the issue tracker.
Contributions should follow the established coding, documentation, and
`Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ style guidelines.

----

Citation
========

If you use Trilobite in your research, please acknowledge it with:

*We acknowledge the use of the Trilobite software package, written by E. Diggins et al., in this work.*

TRILOBITE is developed and maintained by Eliza Diggins and the
**Extragalactic Transients Group (TREX)** in the Department of Astronomy at the
**University of California, Berkeley**.

----

.. |Tests| image:: https://github.com/TransientsExtragalactic/Trilobite/actions/workflows/run_tests.yml/badge.svg
:target: https://github.com/TransientsExtragalactic/Trilobite/actions/workflows/run_tests.yml
:alt: Tests

.. |docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: https://transientsextragalactic.github.io/Trilobite
:alt: Latest Docs

.. |docs-stable| image:: https://img.shields.io/badge/docs-stable-brightgreen.svg
:target: https://transientsextragalactic.github.io/Trilobite/stable
:alt: Stable Docs

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff

.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit

.. |numpydoc| image:: https://img.shields.io/badge/docstyle-numpydoc-459db9
:target: https://numpydoc.readthedocs.io/en/latest/
:alt: Docstring style: numpydoc

.. |commitizen| image:: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
:target: https://commitizen-tools.github.io/commitizen/
:alt: Commit style: Conventional + Gitmoji

.. |conventional-commits| image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white
:target: https://www.conventionalcommits.org/en/v1.0.0/
:alt: Commit style: Conventional Commits

.. |contributors| image:: https://img.shields.io/github/contributors/TransientsExtragalactic/Trilobite?cacheSeconds=86400
:target: https://github.com/TransientsExtragalactic/Trilobite/graphs/contributors
:alt: GitHub Contributors

.. |last-commit| image:: https://img.shields.io/github/last-commit/TransientsExtragalactic/Trilobite?cacheSeconds=86400
:target: https://github.com/TransientsExtragalactic/Trilobite
:alt: Last Commit

.. |ASTROPY| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
:target: http://www.astropy.org/
:alt: Powered by Astropy

.. |docformatter| image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba
:target: https://github.com/PyCQA/docformatter
:alt: docformatter

.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
:alt: isort