Metadata-Version: 2.1
Name: basil_core
Version: 1.2.2
Summary: BASIL-CORE: Bayesian Analytic Sampling and Integrating Library - Compiled and low-dependency utilities
Keywords: Gravitational Wave,Bayesian Inference
Author-Email: "V. Delfavero" <vdfavero@cita.utoronto.ca>
Maintainer-Email: "V. Delfavero" <vdfavero@cita.utoronto.ca>
License: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Project-URL: Homepage, https://gitlab.com/xevra/basil-core
Project-URL: Bug tracker, https://gitlab.com/xevra/basil-core/issues
Requires-Python: >=3.12
Requires-Dist: h5py>=2.7.0
Requires-Dist: numpy<2.4.0,>=2.0
Requires-Dist: matplotlib>=2.2.4
Requires-Dist: scipy>=1.5.0
Requires-Dist: six>=1.10.0
Requires-Dist: fast_histogram>=0.10
Requires-Dist: xev-data>=0.1.1
Requires-Dist: astropy>=6.0
Requires-Dist: pathlib
Description-Content-Type: text/markdown

# Basil Core
BASIL (Bayesian Analytic Sampling and Integrating Library) Core utilities;

Core utilities: A bunch of c functions that are faster than numpy matrix operations (and more conservative of your computer's RAM).

I am using this primarily in gravitational-wave population synthesis, for postprocessing with different binary evolution simulations.

User guide and jupyter notebooks incoming TBD.

## stats

`basil_core.stats.distance`
Right now, this includes a Bhattacharyya distance, Helinski distance, and relative entropy calculation
The relative entropy calculation has the advantage that it can accept pre-computed log values for P and Q.

## Astro

`basil_core.astro.coordinates` includes many coordinate transforms useful for GW astronomy, including chieff/chiminus transformations and tidal deformability parameters.

`basil_core.astro.orbit` includes many useful napkin calculations for GW astronomy, such as a timescale for a GW merger as a function of radius.
Many of these were adapted from [hush](https://github.com/katiebreivik/hush)

## Installation:

```
python3 -m pip install basil-core
```

## Contributing

We are open to pull requests.

If you would like to make a contribution, please explain what changs your are making and why.

## License
[MIT](https://choosealicense.come/licenses/mit)
