License and Citation Files

CITATION.cff

@@ -0,0 +1,26 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "POPSIM: Plasma OPerational SIMulation"
+version: 0.1.0
+repository-code: "https://github.com/MIT-PSFC/POPSIM-Public"
+license: MIT
+authors:
+  - family-names: Wang
+    given-names: Allen
+    email: allenw@mit.edu
+    affiliation: Massachusetts Institute of Technology
+    orcid: "https://orcid.org/0000-0002-1652-3354"
+  - family-names: Keith
+    given-names: Zander
+    email: zkeith@mit.edu
+    affiliation: Massachusetts Institute of Technology
+    orcid: "https://orcid.org/0000-0003-0590-9494"
+  - family-names: Boyer
+    given-names: M. Dan
+    affiliation: Commonwealth Fusion Systems
+    email: "dboyer@cfs.energy"
+    orcid: "https://orcid.org/0000-0002-6845-9155"
+  - family-names: Nelson
+    given-names: A. Oak
+    affiliation: Columbia University
+    orcid: "https://orcid.org/0000-0002-9612-1936"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Allen Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -26,6 +26,19 @@ bash install.sh
    5. Install git lfs and do a `git lfs install` and a `git lfs pull` to get the necessary data files.
    6. Be sure to use either `uv run` to execute commands in the virtual environment. If you are confused, check out the [uv docs](https://docs.astral.sh/uv/)
 
+## Citing POPSIM
+To cite this repository:
+```
+@software{Wang_POPSIM_Plasma_OPerational,
+    author = {Wang, Allen and Keith, Zander and Boyer, M. Dan and Nelson, A. Oak},
+    license = {MIT},
+    title = {{POPSIM: Plasma OPerational SIMulation}},
+    url = {https://github.com/MIT-PSFC/POPSIM-Public},
+    version = {0.1.0},
+}
+```
+
 ## References
 [1] Wang, Allen, et al. "Magnetic Control with an Inverse Grad-Shafranov Neural Network." DPP 2025. 2025.
+
 [2] Wang, Allen M., et al. "Technical Aspects of Plasma Operational Simulation (POPSIM): A Framework for Data-Driven Simulation and Control." arXiv preprint arXiv:2509.10244 (2025).