Skip to content
Snippets Groups Projects
README.md 2.69 KiB
Newer Older
<div align="center">
  <img src="doc/sphinx/source/_static/LogoNNPDF.png" height=100>
</div>

Zahari's avatar
Zahari committed
![Build status](https://github.com/NNPDF/nnpdf/actions/workflows/tests.yml/badge.svg)
Stefano Carrazza's avatar
Stefano Carrazza committed
[![DOI](https://zenodo.org/badge/118135201.svg)](https://zenodo.org/badge/latestdoi/118135201)
Nathan Hartland's avatar
Nathan Hartland committed

Zahari's avatar
Zahari committed
# NNPDF: An open-source machine learning framework for global analyses of parton distributions
Nathan Hartland's avatar
Nathan Hartland committed

Zahari's avatar
Zahari committed
[The NNPDF collaboration](http://nnpdf.science) determines the structure of the
proton using Machine Learning methods. This is the main repository of the
Zahari's avatar
Zahari committed
fitting and analysis frameworks. In particular it contains all the necessary
Zahari's avatar
Zahari committed
tools to [reproduce](https://docs.nnpdf.science/tutorials/reproduce.html) the
Zaharid's avatar
Zaharid committed
[NNPDF4.0 PDF determinations](https://arxiv.org/abs/2109.02653).
Zahari's avatar
Zahari committed
## Documentation
Stefano Carrazza's avatar
Stefano Carrazza committed

Zahari's avatar
Zahari committed
The documentation is available at <https://docs.nnpdf.science/>
Stefano Carrazza's avatar
Stefano Carrazza committed

Zahari's avatar
Zahari committed
## Install
Stefano Carrazza's avatar
Stefano Carrazza committed

See the [NNPDF installation
guide](https://docs.nnpdf.science/get-started/installation.html) for the 
conda package, and how to build from source.

Please note
Zahari's avatar
Zahari committed
that the [conda](https://docs.conda.io/en/latest/) based workflow described in
the documentation is the only supported one. While it may be possible to set up
the code in different ways, we won't be able to provide any assistance.
Stefano Carrazza's avatar
Stefano Carrazza committed

We follow a rolling development model where the tip of the master branch is 
expected to be stable, tested and correct. For more information see our 
[releases and compatibility policy](https://docs.nnpdf.science/releases.html).

Zahari's avatar
Zahari committed
## Cite
Stefano Carrazza's avatar
Stefano Carrazza committed

This code is described in the following [paper](https://inspirehep.net/literature?sort=mostrecent&size=25&page=1&q=find%20eprint%202109.02671):
Zaharid's avatar
Zaharid committed

```
@article{NNPDF:2021uiq,
Zaharid's avatar
Zaharid committed
    author = "Ball, Richard D. and others",
    collaboration = "NNPDF",
Zaharid's avatar
Zaharid committed
    title = "{An open-source machine learning framework for global analyses of parton distributions}",
    eprint = "2109.02671",
    archivePrefix = "arXiv",
    primaryClass = "hep-ph",
    reportNumber = "Edinburgh 2021/13, Nikhef-2021-020, TIF-UNIMI-2021-12",
    doi = "10.1140/epjc/s10052-021-09747-9",
    journal = "Eur. Phys. J. C",
    volume = "81",
    number = "10",
    pages = "958",
Zaharid's avatar
Zaharid committed
    year = "2021"
}
```
Zahari's avatar
Zahari committed
If you use the code to produce new results in a scientific publication, please
follow the [Citation Policy](https://docs.nnpdf.science/get-started/cite.html),
particularly in regards to the papers relevant for QCD NNLO and EW NLO
calculations incorporated in the NNPDF dataset.
Zahari's avatar
Zahari committed
## Contribute
Stefano Carrazza's avatar
Stefano Carrazza committed

Zahari's avatar
Zahari committed
We welcome bug reports or feature requests sent to the [issue
tracker](https://github.com/NNPDF/nnpdf/issues). You may use the issue tracker
for help and questions as well.
Stefano Carrazza's avatar
Stefano Carrazza committed

Zahari's avatar
Zahari committed
If you would like contribute to the code, please follow the [Contribution
Guidelines](https://docs.nnpdf.science/contributing/index.html).