From ca19812f88b228c87f155013dc7b68ba9243cc0d Mon Sep 17 00:00:00 2001 From: ZanderKeith Date: Thu, 16 Apr 2026 13:03:19 -0400 Subject: [PATCH 1/4] Added license and citation files --- CITATION.cff | 24 ++++++++++++++++++++++++ LICENSE | 21 +++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 CITATION.cff create mode 100644 LICENSE diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..d6cd2306 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,24 @@ +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 + - family-names: Nelson + given-names: A. Oak + affiliation: Columbia University + orcid: "https://orcid.org/0000-0002-9612-1936" diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..5e2e8488 --- /dev/null +++ b/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. \ No newline at end of file From ffea3c03cb96bbea526cbf485870f7d521b68b43 Mon Sep 17 00:00:00 2001 From: ZanderKeith Date: Mon, 27 Apr 2026 14:04:39 -0400 Subject: [PATCH 2/4] Added Dan's info to citation --- CITATION.cff | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CITATION.cff b/CITATION.cff index d6cd2306..c522a532 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -18,6 +18,8 @@ authors: - 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 From a326685fc2195016af7dcefef885fc73f5ee1490 Mon Sep 17 00:00:00 2001 From: ZanderKeith Date: Mon, 27 Apr 2026 14:18:12 -0400 Subject: [PATCH 3/4] Added DOI and fixed spacing of references in the README --- CITATION.cff | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CITATION.cff b/CITATION.cff index c522a532..b4c16026 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,6 +2,7 @@ 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 +doi: "10.48550/arXiv.2509.10244" repository-code: "https://github.com/MIT-PSFC/POPSIM-Public" license: MIT authors: diff --git a/README.md b/README.md index 637c3065..64d21d2b 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,5 @@ bash install.sh ## 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). \ No newline at end of file From 4ff3595c8b866504c65bc37820f869d372150224 Mon Sep 17 00:00:00 2001 From: ZanderKeith Date: Mon, 27 Apr 2026 14:31:15 -0400 Subject: [PATCH 4/4] Added citation section in README, removed doi since that is to a different object --- CITATION.cff | 1 - README.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index b4c16026..c522a532 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,7 +2,6 @@ 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 -doi: "10.48550/arXiv.2509.10244" repository-code: "https://github.com/MIT-PSFC/POPSIM-Public" license: MIT authors: diff --git a/README.md b/README.md index 64d21d2b..d06d0f43 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,18 @@ 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.