Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
manuel-morales-a committed Jan 29, 2024
1 parent da3e568 commit 9e68d9d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 41 deletions.
Binary file added PBSP_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 28 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,51 @@
<div align="center">
<img src="doc/sphinx/source/_static/LogoNNPDF.png" height=100>
<img src="PBSP_logo.png" height=100>
</div>

![Build status](https://github.com/NNPDF/nnpdf/actions/workflows/tests.yml/badge.svg)
[![DOI](https://zenodo.org/badge/118135201.svg)](https://zenodo.org/badge/latestdoi/118135201)
[![DOI](Pending)](Pending)

# NNPDF: An open-source machine learning framework for global analyses of parton distributions
# SIMUnet: Leveraging open-source machine learning to explore the interplay between parton distribution functions and potential new physics

[The NNPDF collaboration](http://nnpdf.science) 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](https://docs.nnpdf.science/tutorials/reproduce.html) the
[NNPDF4.0 PDF determinations](https://arxiv.org/abs/2109.02653).
[PBSP](https://www.pbsp.org.uk/) (Physics Beyond the Standard Proton) is an ERC funded project, led by Prof. Maria Ubiali and based at the Department of Applied Mathematics and Theoretical Physics at the University of Cambridge. The projects focuses on the global interpretation of the LHC data in terms of indirect searches for new physics, by providing a robust framework to globally interpret all subtle deviations from the SM predictions that might arise at colliders.

## Documentation
The PBSP team has developed the SIMUnet methodology, which uses machine learning techniques to study the interplay between PDFs and potential new physics signals. Drawing upon
the [NNPDF methodology](https://arxiv.org/abs/2109.02653), SIMUnet provides an augmented framework with a suite of tools that allows the user to

The documentation is available at <https://docs.nnpdf.science/>
- Perform simultaneous fits of PDFs and EFT coefficients
- Perform Fixed-PDF fits of EFT coefficients
- Assess the possible absorption of new physics by the PDFs
- Study the interplay between PDFs and EFT coefficients
- Analyse the results and produce posterior distributions, correlations, confidence levels, and general quality metrics and plots

## Install
## Documentation

See the [NNPDF installation
guide](https://docs.nnpdf.science/get-started/installation.html) for the
conda package, and how to build from source.
The documentation is available at the official [SIMUnet website](https://hep-pbsp.github.io/SIMUnet/sphinx/build/html/index.html).

Please note
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.
## Install

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).
See the [SIMUnet installation tutorial](https://hep-pbsp.github.io/SIMUnet/sphinx/build/html/tutorials/Installation.html).

## Cite

This code is described in the following [paper](https://inspirehep.net/literature?sort=mostrecent&size=25&page=1&q=find%20eprint%202109.02671):
The SIMUnet code has been developed in [the original paper](https://inspirehep.net/literature/2013000):

```
@article{Ball:2021xlu,
author = "Ball, Richard D. and others",
title = "{An open-source machine learning framework for global analyses of parton distributions}",
eprint = "2109.02671",
@article{Iranipour:2022iak,
author = "Iranipour, Shayan and Ubiali, Maria",
title = "{A new generation of simultaneous fits to LHC data using deep learning}",
eprint = "2201.07240",
archivePrefix = "arXiv",
primaryClass = "hep-ph",
reportNumber = "Edinburgh 2021/13, Nikhef-2021-020, TIF-UNIMI-2021-12",
month = "9",
year = "2021"
doi = "10.1007/JHEP05(2022)032",
journal = "JHEP",
volume = "05",
pages = "032",
year = "2022"
}
```

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.

## Contribute
and the [official release](pending).

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.
## Bugs and contributions

If you would like contribute to the code, please follow the [Contribution
Guidelines](https://docs.nnpdf.science/contributing/index.html).
If you find a bug or have a new feature idea, do not hesitate to drop them in our [issue tracker](https://github.com/HEP-PBSP/SIMUnet/issues).

0 comments on commit 9e68d9d

Please sign in to comment.