Metadata-Version: 2.4
Name: pineappl
Version: 1.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: numpy>=1.16.0
Requires-Dist: pineappl-cli ; extra == 'cli'
Requires-Dist: sphinx>=7.0.0 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=1.2.2 ; extra == 'docs'
Requires-Dist: nbsphinx>=0.8.8 ; extra == 'docs'
Requires-Dist: ipykernel>=6.13.0 ; extra == 'docs'
Requires-Dist: polars>=1.8.0 ; extra == 'docs'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Provides-Extra: cli
Provides-Extra: docs
Provides-Extra: test
Summary: Python bindings to PineAPPL
Keywords: high-energy-physics,physics
Author: Christopher Schwan <handgranaten-herbert@posteo.de>, Alessandro Candido <candido.ale@gmail.com>, Felix Hekhorn <felix.hekhorn@mi.infn.it>, Tanjona R. Rabemananjara <tanjona.hepc@gmail.com>
Author-email: Christopher Schwan <handgranaten-herbert@posteo.de>, Alessandro Candido <candido.ale@gmail.com>, Felix Hekhorn <felix.hekhorn@mi.infn.it>, Tanjona R. Rabemananjara <tanjona.hepc@gmail.com>
License: GPL-3.0-or-later
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: homepage, https://nnpdf.github.io/pineappl/
Project-URL: documentation, https://pineappl.readthedocs.io/
Project-URL: changelog, https://nnpdf.github.io/pineappl/CHANGELOG.html

[![PyPI version](https://badge.fury.io/py/pineappl.svg)](https://badge.fury.io/py/pineappl)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/pineappl/badges/installer/conda.svg)](https://anaconda.org/conda-forge/pineappl)
[![AUR](https://img.shields.io/aur/version/pineappl)](https://aur.archlinux.org/packages/pineappl)
[![Documentation Status](https://readthedocs.org/projects/pineappl/badge/?version=latest)](https://pineappl.readthedocs.io/en/latest/?badge=latest)

# Python bindings for PineAPPL

This crate uses [PyO3] to provide Python bindings to PineAPPL's [Rust API].

For installation instructions see the [documentation].

[PyO3]: https://pyo3.rs
[Rust API]: https://docs.rs/pineappl
[documentation]: https://pineappl.readthedocs.io/en/latest/installation.html

## Development

Run

```shell
python -m venv env && . env/bin/activate
```

to setup a new environment and check that `pip --version` returns at least `pip
22.0 from ...`. If not, upgrade `pip` via

```shell
pip install -U pip
```

Next, install `maturin`:

```shell
pip install maturin
```

Run

```shell
maturin develop
```

to build the project, which also installs it into the environment so that it
can be used in Python projects that use the same environment.

### Documentation

Run the following once to install the documentation's dependencies:

```shell
pip install '.[docs]'
```

Then run

```shell
( cd docs && make clean html )
```

to generate the documentation.

