Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bandframework/rose

The Reduced-Order Scattering Emulator (rose) is a user-friendly software for building efficient surrogate models for nuclear scattering

https://github.com/bandframework/rose

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: aps.org, iop.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

The Reduced-Order Scattering Emulator (rose) is a user-friendly software for building efficient surrogate models for nuclear scattering

Basic Info
Statistics
  • Stars: 11
  • Watchers: 3
  • Forks: 3
  • Open Issues: 9
  • Releases: 10
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

Python package

ROSE - The Reduced-Order Scattering Emulator

ROSE makes it easy to build and train a scattering emulator. ROSE enables aspiring graduate students and long-suffering postdocs to emulate nuclear scattering observables with optical potentials, trading negligible amounts of accuracy for orders-of-magnitude gains in speed.

For any bug reports or feature requests, please make use of the Github issues tab on the repository. We also welcome all pull requests for software, documentation, and user-contributed tutorials!

Installation

ROSE is hosted at pypi.org/project/nuclear-rose/. To install as a user, run the following

pip install nuclear-rose.

To install as a developer, clone the repository and run

pip install -e .

from within the project root directory.

Usage

To emulate an interaction, you will make an Interaction class, or something similar. Then you will typically make a ScatteringAmplitudeEmulator, which will train an emulator to emulate elastic cross sections.

For a full set of examples walking through emulation and calibration, check the tutorials directory.

Documentation

You can also check out the documentation page.

More software

You could even check the other BAND softwares and start combining them to write all your Bayesian papers!

Citation

ROSE, and the theory behind it, were introduced in this publication. If you use ROSE, please cite it like so:

tex @article{PhysRevC.109.044612, title = {ROSE: A reduced-order scattering emulator for optical models}, author = {Odell, D. and Giuliani, P. and Beyer, K. and Catacora-Rios, M. and Chan, M. Y.-H. and Bonilla, E. and Furnstahl, R. J. and Godbey, K. and Nunes, F. M.}, journal = {Phys. Rev. C}, volume = {109}, issue = {4}, pages = {044612}, numpages = {17}, year = {2024}, month = {Apr}, publisher = {American Physical Society}, doi = {10.1103/PhysRevC.109.044612}, url = {https://link.aps.org/doi/10.1103/PhysRevC.109.044612} }

Additionally, as ROSE is part of the BAND software framework, please consider citing the BAND Manifesto.

Owner

  • Name: BAND
  • Login: bandframework
  • Kind: organization

GitHub Events

Total
  • Issues event: 3
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 304
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 1
Last Year
  • Issues event: 3
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 304
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 1
  • Average time to close issues: 28 days
  • Average time to close pull requests: 3 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: 28 days
  • Average time to close pull requests: 3 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • beykyle (19)
  • pabggpnMSU (4)
  • kylegodbey (1)
  • odell (1)
  • mosesyhc (1)
Pull Request Authors
  • beykyle (7)
  • mosesyhc (2)
  • kylegodbey (2)
Top Labels
Issue Labels
kd-extension (10) help wanted (3) enhancement (3) bug (2) documentation (1)
Pull Request Labels
kd-extension (1)

Dependencies

.github/workflows/docs-publish.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/git-repo-stats.yml actions
  • jgehrcke/github-repo-stats RELEASE composite
.github/workflows/pypi-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
requirements.txt pypi
  • mkdocs-jupyter >=0.24.2
  • mkdocs-material >=9.1.18
  • mkdocstrings >=0.22.0
  • mkdocstrings-python >=1.1.2
  • mpmath >=1.2.1
  • numpy >=1.21.5
  • scipy >=1.10.1
  • tqdm >=4.62.3