nplm
package for the New Physics Learning Machine (NPLM) algorithm
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.2%) to scientific vocabulary
Repository
package for the New Physics Learning Machine (NPLM) algorithm
Basic Info
- Host: GitHub
- Owner: GaiaGrosso
- License: mit
- Language: Jupyter Notebook
- Default Branch: v0.1.0
- Size: 8.2 MB
Statistics
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
NPLM_package
a package to implement the New Physics Learning Machine (NPLM) algorithm
Short description:
NPLM is a strategy to detect data departures from a given reference model, with no prior bias on the nature of the new physics model responsible for the discrepancy. The method employs neural networks, leveraging their virtues as flexible function approximants, but builds its foundations directly on the canonical likelihood-ratio approach to hypothesis testing. The algorithm compares observations with an auxiliary set of reference-distributed events, possibly obtained with a Monte Carlo event generator. It returns a p-value, which measures the compatibility of the reference model with the data. It also identifies the most discrepant phase-space region of the dataset, to be selected for further investigation. Imperfections due to mis-modelling in the reference dataset can be taken into account straightforwardly as nuisance parameters.
Related works:
- "Learning New Physics from a Machine" (Phys. Rev. D)
- "Learning Multivariate New Physics" (Eur. Phys. J. C)
- "Learning New Physics from an Imperfect Machine" (Eur. Phys. J. C)
Envirnoment set up:
Create a virtual environment with the packages specified in requirements.txt
python3 -m venv env
source env/bin/activate
to be sure that pip is up to date
pip install --upgrade pip
install the packaes listed in requirements.txt
pip install -r requirements.txt
to see what you installed (check if successful)
pip freeze
Now you are ready to download the NPLM package:
pip install NPLM
Envirnoment set up on lxplus at Cern
Just source the virtual environment:
source /cvmfs/sft.cern.ch/lcg/views/LCG_99/x86_64-centos7-gcc10-opt/setup.sh
Download the NPLM package:
pip install NPLM
Main features in the package:
imperfect_model
## Example: 1D toy model
To understand how NPLM works see the 1D example in example_1D
Owner
- Login: GaiaGrosso
- Kind: user
- Repositories: 9
- Profile: https://github.com/GaiaGrosso
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Grosso
given-names: Gaia
orcid: https://orcid.org/0000-0002-8303-3291
title: "New Physics Learning Machine (NPLM): package"
version: 0.0.6
date-released: 2021-11-17
url: "https://github.com/GaiaGrosso/NPLM_package"
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: about 3 years ago
All Time
- Total Commits: 49
- Total Committers: 3
- Avg Commits per committer: 16.333
- Development Distribution Score (DDS): 0.102
Top Committers
| Name | Commits | |
|---|---|---|
| GaiaGrosso | 3****o@u****m | 44 |
| Gaia | g****a@G****l | 4 |
| Gaia | g****a@g****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 1 minute
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 12 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 1
- Total maintainers: 1
pypi.org: nplm
package to run the New Physics Learning Machine (NPLM) algorithm.
- Homepage: https://github.com/GaiaGrosso/NPLM_package
- Documentation: https://nplm.readthedocs.io/
- License: MIT License
-
Latest release: 0.0.6
published about 4 years ago
Rankings
Maintainers (1)
Dependencies
- h5py *
- matplotlib ==3.3.3
- numpy >=1.18
- scipy ==1.4.1
- tensorflow ==2.3