{"id":31225148,"url":"https://github.com/pylhc/irnl_rdt_correction","last_synced_at":"2026-02-13T23:32:30.072Z","repository":{"id":43055522,"uuid":"470504700","full_name":"pylhc/irnl_rdt_correction","owner":"pylhc","description":"Correction script to power the nonlinear correctors in the (HL-)LHC insertion regions based on RDTs.","archived":false,"fork":false,"pushed_at":"2024-10-28T14:08:23.000Z","size":45733,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-07-09T13:12:03.360Z","etag":null,"topics":["accelerator","correction","hl-lhc","lhc","nonlinear"],"latest_commit_sha":null,"homepage":"https://pylhc.github.io/irnl_rdt_correction/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pylhc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-16T09:02:19.000Z","updated_at":"2024-10-28T14:06:48.000Z","dependencies_parsed_at":"2023-02-12T01:16:03.748Z","dependency_job_id":"2ef09ad5-844f-4efc-9735-5d37a304742a","html_url":"https://github.com/pylhc/irnl_rdt_correction","commit_stats":{"total_commits":31,"total_committers":2,"mean_commits":15.5,"dds":"0.032258064516129004","last_synced_commit":"88671dc6129009ce8467c27437d11f4ebfc77bb0"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pylhc/irnl_rdt_correction","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylhc%2Firnl_rdt_correction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylhc%2Firnl_rdt_correction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylhc%2Firnl_rdt_correction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylhc%2Firnl_rdt_correction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pylhc","download_url":"https://codeload.github.com/pylhc/irnl_rdt_correction/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylhc%2Firnl_rdt_correction/sbom","scorecard":{"id":751546,"data":{"date":"2025-08-11","repo":{"name":"github.com/pylhc/irnl_rdt_correction","commit":"602a831458485951e29fd0df2a0984a456260c8d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":8,"reason":"Found 6/7 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/coverage.yml:1","Warn: no topLevel permission defined: .github/workflows/cron.yml:1","Warn: no topLevel permission defined: .github/workflows/documentation.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/coverage.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/pylhc/irnl_rdt_correction/coverage.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/cron.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/pylhc/irnl_rdt_correction/cron.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/documentation.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pylhc/irnl_rdt_correction/documentation.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/pylhc/irnl_rdt_correction/publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/pylhc/irnl_rdt_correction/tests.yml/master?enable=pin","Info:   0 out of   5 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T20:31:34.462Z","repository_id":43055522,"created_at":"2025-08-22T20:31:34.462Z","updated_at":"2025-08-22T20:31:34.462Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275919449,"owners_count":25552632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-19T02:00:09.700Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accelerator","correction","hl-lhc","lhc","nonlinear"],"created_at":"2025-09-22T00:40:42.291Z","updated_at":"2025-09-22T00:40:45.737Z","avatar_url":"https://github.com/pylhc.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IRNL RDT Correction \n\n[![Cron Testing](https://github.com/pylhc/irnl_rdt_correction/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/irnl_rdt_correction/actions?query=workflow%3A%22Cron+Testing%22)\n[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/irnl_rdt_correction.svg?style=popout)](https://codeclimate.com/github/pylhc/irnl_rdt_correction)\n[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/irnl_rdt_correction.svg?style=popout)](https://codeclimate.com/github/pylhc/irnl_rdt_correction)\n[![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/irnl_rdt_correction.svg?style=popout)](https://github.com/pylhc/irnl_rdt_correction/)\n[![GitHub release](https://img.shields.io/github/release/pylhc/irnl_rdt_correction.svg?style=popout)](https://github.com/pylhc/irnl_rdt_correction/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6373374.svg)](https://doi.org/10.5281/zenodo.6373374)\n\nPerforms local correction of the Resonance Driving Terms (RDTs)\nin the Insertion Regions (IRs) based on the principle described in\n[[1]](#1) with the addition of correcting\nfeed-down and using feed-down to correct lower order RDTs.\nDetails can be found in [[2]](#2).\n\n\n## Documentation\n\n- The note containing background, derivation and implementation details can be found in the attached [note](latex/note.pdf).\n- Autogenerated docs via `Sphinx` can be found at \u003chttps://pylhc.github.io/irnl_rdt_correction/\u003e.\n\n## Installing\n\nThis package is `Python 3.7+` compatible, and can be installed through `pip`:\n```bash\npython -m pip install irnl-rdt-correction\n```\n\nAfter installing, scripts can be run with either `python -m irnl_rdt_correction --FLAG ARGUMENT` or by calling the Python files directly.\n\nFor development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies:\n```bash\ngit clone https://github.com/pylhc/irnl_rdt_correction\npython -m pip install --editable \"irnl_rdt_correction[all]\"\n```\n\n## Main Script \n\n-  [**irnl_rdt_correction.py**](irnl_rdt_correction/main.py) - Script to compute RDT correction in the (HL)LHC IRs including feed-down effects.\n\n## License\n\nThis project is licensed under the `MIT` License - see the [LICENSE](LICENSE) file for details.\n\n\n## References\n\n\u003ca id=\"1\"\u003e[1]\u003c/a\u003e :\nO. Bruening et al.,\nDynamic aperture studies for the LHC separation dipoles. (2004)\nhttps://cds.cern.ch/record/742967\n\n\u003ca id=\"2\"\u003e[2]\u003c/a\u003e :\nJ. Dilly and R. Tomás,\nA flexible nonlinear Resonance Driving Term based Correction Algorithm with feed-down. (2022)\n[note.pdf](latex/note.pdf)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpylhc%2Firnl_rdt_correction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpylhc%2Firnl_rdt_correction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpylhc%2Firnl_rdt_correction/lists"}