Merge pull request #74 from bandframework/develop

Develop
bandframework · Aug 27, 2024 · cd96112 · cd96112
2 parents 5c7f706 + 772a848
commit cd96112
Show file tree

Hide file tree

Showing 6 changed files with 122 additions and 189 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,19 @@ For any bug reports or feature requests, please make use of the Github issues ta
 
 ## Installation
 
-To install, run the following 
+ROSE is hosted at [pypi.org/project/nuclear-rose/](https://pypi.org/project/nuclear-rose/). To install as a user, run the following 
 
-`pip install nuclear-rose`
+`pip install nuclear-rose`.
+
+To install as a developer, clone the repository and run
+
+`pip install -e .`
+
+from within the project root directory.
 
 ## Usage
 
-The primary class is `ReducedBasisEmulator`. To create an instance, minimally, an instance of the `Interaction` class, a set of training points, the energy, and angular momentum need to be specified. 
+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](docs/tutorials/) directory.
 
@@ -26,3 +32,25 @@ You can also check out the [documentation page](https://reduced-order-scattering
 
 You could even check the other [BAND softwares](https://bandframework.github.io/software/) and start combining them to write all your Bayesian papers!
 
+## Citation
+
+ROSE, and the theory behind it, were introduced in [this publication](https://journals.aps.org/prc/abstract/10.1103/PhysRevC.109.044612). 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](https://iopscience.iop.org/article/10.1088/1361-6471/abf1df).
diff --git a/docs/tutorials/CAT_tutorial.png b/docs/tutorials/CAT_tutorial.png
diff --git a/docs/tutorials/ROSE_tutorial_0_quickstart.ipynb b/docs/tutorials/ROSE_tutorial_0_quickstart.ipynb
diff --git a/docs/tutorials/ROSE_tutorial_1_building_an_emulator.ipynb b/docs/tutorials/ROSE_tutorial_1_building_an_emulator.ipynb
diff --git a/docs/tutorials/ROSE_tutorial_2_optical_potential_surmise_UQ.ipynb b/docs/tutorials/ROSE_tutorial_2_optical_potential_surmise_UQ.ipynb
diff --git a/src/rose/utility.py b/src/rose/utility.py
@@ -422,7 +422,7 @@ def kinematics(
         / HBARC
     )
     mu = k**2 * Ep / (Ep**2 - m_p * m_p) * HBARC**2
-    k_C = ALPHA * projectile[1] * target[1] * mu
+    k_C = ALPHA * projectile[1] * target[1] * mu / HBARC
     eta = k_C / k
 
     if return_Elab: