nnpdf / workflows

NNPDF: An open-source machine learning framework for global analyses of parton distributions

The NNPDF collaboration determines the structure of the proton using Machine Learning methods. This is the main repository of the fitting and analysis frameworks. In particular it contains all the necessary tools to reproduce the NNPDF4.0 PDF determinations.

Documentation

The documentation is available at https://docs.nnpdf.science/

Install

See the NNPDF installation guide for the conda package, and how to build from source.

Please note that the conda 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.

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.

Cite

This code is described in the following paper:

@article{NNPDF:2021uiq,
    author = "Ball, Richard D. and others",
    collaboration = "NNPDF",
    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",
    year = "2021"
}

If you use the code to produce new results in a scientific publication, please follow the Citation Policy, particularly in regards to the papers relevant for QCD NNLO and EW NLO calculations incorporated in the NNPDF dataset.

Contribute

We welcome bug reports or feature requests sent to the issue tracker. You may use the issue tracker for help and questions as well.

If you would like contribute to the code, please follow the Contribution Guidelines.

workflows's Issues

Add git and curl to the lhapdf container

@AleCandido Could you please add git>=2.18 to the lhapdf container? Currently checkout@v2 uses the REST API (https://github.com/NNPDF/nnusf/actions/runs/3197091119/jobs/5219862852) to download the tar. Also, the installation of poetry fails because curl is not installed.

Add Codecov tokens everywhere

qiboteam/workflows#44

Poetry in RTD

As done for EKO we should use Poetry to install deps on readthedocs as well.

The current solution was just a temporary hack.

Here the official guide: https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry

NOTE: I'm putting it here, but of course is intended for all the other repos: yadism, pineko, pinefarm, ...

Outdated PyPI workflow

Looking here https://github.com/N3PDF/pineko/actions/runs/2874826710 we got

publish / 📦 PyPI (🐍 3.8): # >> PyPA publish to PyPI GHA: UNSUPPORTED GITHUB ACTION VERSION <<#L1
You are using "pypa/gh-action-pypi-publish@master". The "master" branch of this project has been sunset and will not receive any updates, not even security bug fixes. Please, make sure to use a supported version. If you want to pin to v1 major version, use "pypa/gh-action-pypi-publish@release/v1". If you feel adventurous, you may opt to use use "pypa/gh-action-pypi-publish@unstable/v1" instead. A more general recommendation is to pin to exact tags or commit shas.

since we're on it: shall we increase the default Python version?

Add the possibility to include a Docker container

It will be a nice feature to have the possibility to include a container in the on.workflow_call.inputs in case some actions require specific programs. A status check (as illustrated here) will be required in case no container is passed.