Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
run: |
curl -fsSL "$GPG" \
| sudo tee "$KEY"
echo "deb [arch=amd64 signed-by=$KEY] $REPO MDSplus alpha" \
echo "deb [arch=amd64 signed-by=$KEY] $REPO MDSplus stable" \
| sudo tee "$APT"

- name: Update sources
Expand All @@ -62,7 +62,7 @@ jobs:
run: |
sudo apt-get install msodbcsql17 # pre-installed
sudo apt-get install tdsodbc unixodbc # freetds
sudo apt-get install mdsplus-alpha-python # mdsplus
sudo apt-get install mdsplus-python # mdsplus

- name: Configure MDSplus
if: ${{ matrix.tokamak == 'C-MOD'
Expand Down
97 changes: 56 additions & 41 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,32 +1,4 @@
cff-version: 1.2.0
title: >-
DisruptionPy: An open-source physics-based Scientific
Framework for Disruption Analysis of Fusion Plasmas for
AI/ML applications
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Gregorio L.
family-names: Trevisan
email: gtrevisan@psfc.mit.edu
affiliation: MIT PSFC
orcid: 'https://orcid.org/0000-0003-4920-6109'
- given-names: Cristina
family-names: Rea
email: crea@psfc.mit.edu
affiliation: MIT PSFC
orcid: 'https://orcid.org/0000-0002-9948-2649'
- name: MIT PSFC Disruption Studies Group
website: 'https://disruptions.mit.edu/'
identifiers:
- type: doi
value: 10.5281/zenodo.13935223
description: Zenodo
repository-code: 'https://github.com/MIT-PSFC/disruption-py'
url: 'https://mit-psfc.github.io/disruption-py/'
repository-artifact: 'https://pypi.org/project/disruption-py/'
abstract: >
DisruptionPy is an open-source Scientific Python package
for fast retrieval of experimental Fusion data from
Expand All @@ -35,17 +7,60 @@ abstract: >
The library allows an efficient database preparation for
downstream analysis and/or ML model development for
disruption studies.


Currently supported devices are:

- Alcator C-Mod

- DIII-D

- EAST

- HBT-EP

- MAST
authors:
- family-names: Trevisan
given-names: Gregorio L.
orcid: "https://orcid.org/0000-0003-4920-6109"
- name: MIT PSFC Disruptions Group
website: "https://disruptions.mit.edu"
contact:
- family-names: Trevisan
given-names: Gregorio L.
orcid: "https://orcid.org/0000-0003-4920-6109"
doi: 10.5281/zenodo.13935223
license: MIT
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Trevisan
given-names: Gregorio L.
orcid: "https://orcid.org/0000-0003-4920-6109"
- family-names: Wei
given-names: Yumou
orcid: "https://orcid.org/0000-0002-8868-0017"
- family-names: Decker
given-names: Amos M.
orcid: "https://orcid.org/0009-0004-3728-3259"
- family-names: Lorincz
given-names: Joshua
orcid: "https://orcid.org/0009-0003-0288-9501"
- family-names: Jackson
given-names: Samuel L.
orcid: "https://orcid.org/0000-0001-5301-5095"
- family-names: Rea
given-names: Cristina
orcid: "https://orcid.org/0000-0002-9948-2649"
- family-names: Granetz
given-names: Robert S.
orcid: "https://orcid.org/0000-0002-6560-1881"
- name: MIT PSFC Disruptions Group
website: "https://disruptions.mit.edu"
date-published: 2026-03-31
doi: 10.21105/joss.09364
issn: 2475-9066
issue: 119
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 9364
title: "DisruptionPy: An open-source physics-based scientific
framework for disruption analysis of fusion plasmas"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.09364"
volume: 11
repository-artifact: "https://pypi.org/project/disruption-py/"
repository-code: "https://github.com/MIT-PSFC/disruption-py/"
title: "DisruptionPy: An open-source physics-based scientific framework
for disruption analysis of fusion plasmas"
url: "https://mit-psfc.github.io/disruption-py/"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ For a complete list of contributors, please refer to the [Contributors](https://

DisruptionPy can be cited as follows:

- GL Trevisan, _et al._ (2026), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Journal of Open Source Software, [accepted](https://joss.theoj.org/papers/e98dd4586a1383f120c5005b539ca6f8)
- GL Trevisan, _et al._ (2026), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Journal of Open Source Software **11** 119, DOI: [10.21105/joss.09364](https://doi.org/10.21105/joss.09364)
- GL Trevisan, _et al._ (2024), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Zenodo, DOI: [10.5281/zenodo.13935223](https://doi.org/10.5281/zenodo.13935223)

A list of works derived from DisruptionPy can be found in [REFERENCES.md](REFERENCES.md).
75 changes: 38 additions & 37 deletions REFERENCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,68 +5,69 @@ Here follows a non-exhaustive list of projects, publications, and conference con

### Projects

- C Rea, _et al._ (2023), _"Open and FAIR Fusion for Machine Learning Applications"_, [Project website](https://crea-psfc.github.io/open-fair-fusion/).
- C Rea, _et al._ (2023), _"Open and FAIR Fusion for Machine Learning Applications"_, [Project website](https://disruptions.mit.edu/projects/open-fair-fusion/)
- C Rea, _et al._ (2022), _"SPARC Disruption Strategies Research Project Proposal"_, [Project website](https://disruptions.mit.edu/projects/sparc-rpp/)

### Publications

- GL Trevisan, _et al._ (2026), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Journal of Open Source Software, [accepted](https://joss.theoj.org/papers/e98dd4586a1383f120c5005b539ca6f8)
- AR Saperstein, _et al._ (2025), _"Design and development of an off-normal warning system for SPARC"_, Nuclear Fusion **65** 116007, DOI: [10.1088/1741-4326/ae074e](https://doi.org/10.1088/1741-4326/ae074e)
- L Spangher, _et al._ (2025), _"DisruptionBench and Complimentary New Models: Two Advancements in Machine Learning Driven Disruption Prediction"_, Journal of Fusion Energy **44** 26, DOI: [10.1007/s10894-025-00495-2](https://doi.org/10.1007/s10894-025-00495-2)
- J Stillerman, _et al._ (2025), _"MDSplusML: Optimizations for data access to facilitate machine learning pipelines"_, Fusion Engineering and Design **211** 114770, DOI: [10.1016/j.fusengdes.2024.114770](https://doi.org/10.1016/j.fusengdes.2024.114770)
- AD Maris, _et al._ (2024), _"Correlation of the L-mode density limit with edge collisionality"_, Nuclear Fusion **65** 016051, DOI: [10.1088/1741-4326/ad90f0](https://doi.org/10.1088/1741-4326/ad90f0)
- GL Trevisan, _et al._ (2024), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Zenodo, DOI: [10.5281/zenodo.13935223](https://doi.org/10.5281/zenodo.13935223)
- Z Keith, _et al._ (2024), _"Risk-aware framework development for disruption prediction: Alcator C-Mod and DIII-D survival analysis"_, Journal of Fusion Energy **43** 21, DOI: [10.1007/s10894-024-00413-y](https://doi.org/10.1007/s10894-024-00413-y)
- GL Trevisan, _et al._ (2026), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Journal of Open Source Software **11** 119, DOI: [10.21105/joss.09364](https://doi.org/10.21105/joss.09364), [BibTeX](https://doi2bib.org/bib/10.21105/joss.09364)
- AR Saperstein, _et al._ (2025), _"Design and development of an off-normal warning system for SPARC"_, Nuclear Fusion **65** 116007, DOI: [10.1088/1741-4326/ae074e](https://doi.org/10.1088/1741-4326/ae074e), [BibTeX](https://doi2bib.org/bib/10.1088/1741-4326/ae074e)
- L Spangher, _et al._ (2025), _"DisruptionBench and Complimentary New Models: Two Advancements in Machine Learning Driven Disruption Prediction"_, Journal of Fusion Energy **44** 26, DOI: [10.1007/s10894-025-00495-2](https://doi.org/10.1007/s10894-025-00495-2), [BibTeX](https://doi2bib.org/bib/10.1007/s10894-025-00495-2)
- J Stillerman, _et al._ (2025), _"MDSplusML: Optimizations for data access to facilitate machine learning pipelines"_, Fusion Engineering and Design **211** 114770, DOI: [10.1016/j.fusengdes.2024.114770](https://doi.org/10.1016/j.fusengdes.2024.114770), [BibTeX](https://doi2bib.org/bib/10.1016/j.fusengdes.2024.114770)
- AD Maris, _et al._ (2024), _"Correlation of the L-mode density limit with edge collisionality"_, Nuclear Fusion **65** 016051, DOI: [10.1088/1741-4326/ad90f0](https://doi.org/10.1088/1741-4326/ad90f0), [BibTeX](https://doi2bib.org/bib/10.1088/1741-4326/ad90f0)
- GL Trevisan, _et al._ (2024), _"DisruptionPy: An open-source physics-based scientific framework for disruption analysis of fusion plasmas"_, Zenodo, DOI: [10.5281/zenodo.13935223](https://doi.org/10.5281/zenodo.13935223), [BibTeX](https://doi2bib.org/bib/10.5281/zenodo.13935223)
- Z Keith, _et al._ (2024), _"Risk-aware framework development for disruption prediction: Alcator C-Mod and DIII-D survival analysis"_, Journal of Fusion Energy **43** 21, DOI: [10.1007/s10894-024-00413-y](https://doi.org/10.1007/s10894-024-00413-y), [BibTeX](https://doi2bib.org/bib/10.1007/s10894-024-00413-y)

### Databases

- Z Keith, _et al._ (2025), _"Tearing Mode Database"_, Zenodo, DOI: [10.5281/zenodo.17612862](https://doi.org/10.5281/zenodo.17612862)
- Z Keith, _et al._ (2025), _"Tearing Mode Database"_, Zenodo, DOI: [10.5281/zenodo.17612862](https://doi.org/10.5281/zenodo.17612862), [BibTeX](https://doi2bib.org/bib/10.5281/zenodo.17612862)
- AD Maris, _et al._ (2025), _"Open Density Limit Database"_, Github, [`MIT-PSFC/open_density_limit_database`](https://github.com/MIT-PSFC/open_density_limit_database)
- MIT PSFC Disruption Studies Group (2023-2024), _"AI/ML For Fusion -- Database preparation workflows"_, Github, [`MIT-PSFC/wm-summer-school`](https://github.com/MIT-PSFC/wm-summer-school)

### Conferences

- [6th Fusion HPC Workshop (2026)](https://hpcfusion.bsc.es/2026/)
- EdD Zapata Cornejo, _et al._ (2026), _"Discovering features for confinement regime operational spaces using classification and Bayesian optimization"_
- EdD Zapata Cornejo, _et al._ (2026), _"Discovering features for confinement regime operational spaces using classification and Bayesian optimization"_

- [67th APS-DPP Meeting (2025)](https://meetings.aps.org/Meeting/DPP25)
- AD Maris, _et al._ (2025), _"Collisionality scaling of the tokamak density limit: data-driven analysis, cross-device prediction, and real-time avoidance"_ [BO04.5](https://schedule.aps.org/dpp/2025/events/BO04/5)
- Z Keith, _et al._ (2025), _"Enabling data-driven NTM studies with advanced mode labeling"_, [BP13.164](https://schedule.aps.org/dpp/2025/events/BP13/164)
- C Rea, _et al._ (2025), _"Research in support of the SPARC Off-Normal Warning System"_, [JO04.9](https://schedule.aps.org/dpp/2025/events/JO04/9)
- AR Saperstein, _et al._ (2025), _"Validation of simulated radiative collapse events in TORAX"_, [NP13.155](https://schedule.aps.org/dpp/2025/events/NP13/155)
- H Wietfeldt, _et al._ (2025), _"Characterization of UFOs on Alcator C-Mod and WEST to inform SPARC operation"_ [NP13.157](https://schedule.aps.org/dpp/2025/events/NP13/157)
- EdD Zapata Cornejo, _et al._ (2025), _"Time series classification algorithms for confinement regime identification in C-Mod"_ [NP13.163](https://schedule.aps.org/dpp/2025/events/NP13/163)
- GL Trevisan, _et al._ (2025), _"A large-scale automated EFIT recomputation workflow for disruption studies at 1 kHz"_, [PP13.88](https://schedule.aps.org/dpp/2025/events/PP13/88)
- Y Wei, _et al._ (2025), _"Scikit-disruption: machine learning toolkit for disruption analysis"_, [PP13.93](https://schedule.aps.org/dpp/2025/events/PP13/93)
- AD Maris, _et al._ (2025), _"Collisionality scaling of the tokamak density limit: data-driven analysis, cross-device prediction, and real-time avoidance"_ [BO04.5](https://schedule.aps.org/dpp/2025/events/BO04/5)
- Z Keith, _et al._ (2025), _"Enabling data-driven NTM studies with advanced mode labeling"_, [BP13.164](https://schedule.aps.org/dpp/2025/events/BP13/164)
- C Rea, _et al._ (2025), _"Research in support of the SPARC Off-Normal Warning System"_, [JO04.9](https://schedule.aps.org/dpp/2025/events/JO04/9)
- AR Saperstein, _et al._ (2025), _"Validation of simulated radiative collapse events in TORAX"_, [NP13.155](https://schedule.aps.org/dpp/2025/events/NP13/155)
- H Wietfeldt, _et al._ (2025), _"Characterization of UFOs on Alcator C-Mod and WEST to inform SPARC operation"_ [NP13.157](https://schedule.aps.org/dpp/2025/events/NP13/157)
- EdD Zapata Cornejo, _et al._ (2025), _"Time series classification algorithms for confinement regime identification in C-Mod"_ [NP13.163](https://schedule.aps.org/dpp/2025/events/NP13/163)
- GL Trevisan, _et al._ (2025), _"A large-scale automated EFIT recomputation workflow for disruption studies at 1 kHz"_, [PP13.88](https://schedule.aps.org/dpp/2025/events/PP13/88)
- Y Wei, _et al._ (2025), _"Scikit-disruption: machine learning toolkit for disruption analysis"_, [PP13.93](https://schedule.aps.org/dpp/2025/events/PP13/93)

- [6th International Conference on Data-Driven Plasma Science (2025)](https://web.cvent.com/event/7de9d238-e170-4fbf-8de5-20abc5c6eb49/summary)
- Z Keith, _et al._ (2025), _"A tearing mode database for Alcator C-Mod and DIII-D"_
- Y Wei, _et al._ (2025), _"DisruptionPy: An open-source physics-based scientific package for disruption studies on magnetic fusion experiment devices"_
- Z Keith, _et al._ (2025), _"A tearing mode database for Alcator C-Mod and DIII-D"_
- Y Wei, _et al._ (2025), _"DisruptionPy: An open-source physics-based scientific package for disruption studies on magnetic fusion experiment devices"_

- [45th ITPA-MDC Meeting (2025)](https://sites.google.com/pppl.gov/itpa-mdc2025)
- AD Maris, _et al._ (2025), _"Cross-device prediction and real-time avoidance of the density limit"_
- AR Saperstein, _et al._ (2025), _"Progress on the development of an off-normal warning system for SPARC"_
- H Wietfeldt, _et al._ (2025), _"Characterizing UFO Disruptions on Alcator C-Mod"_
- AD Maris, _et al._ (2025), _"Cross-device prediction and real-time avoidance of the density limit"_
- AR Saperstein, _et al._ (2025), _"Progress on the development of an off-normal warning system for SPARC"_
- H Wietfeldt, _et al._ (2025), _"Characterizing UFO Disruptions on Alcator C-Mod"_

- [3rd AI for Fusion CRP (2025)](https://nucleus.iaea.org/sites/ai4atoms/ai4fusion/SitePages/3rd-Meeting-of-the-AI-for-Fusion-(CRP).aspx)
- C Rea, _et al._ (2025), _"Open and FAIR Fusion for Machine Learning Applications"_
- C Rea, _et al._ (2025), _"Open and FAIR Fusion for Machine Learning Applications"_

- [Open Source Software for Fusion Energy (2025)](https://ossfe.org/OSSFE_2025/#welcome-to-ossfe-2025)
- Y Wei, _et al._ (2025), _"DisruptionPy: an open-source Python library for disruption study."_, [POS-10](https://ossfe.org/OSSFE_2025/y-disruptionpy)
- Y Wei, _et al._ (2025), _"DisruptionPy: an open-source Python library for disruption study."_, [POS-10](https://ossfe.org/OSSFE_2025/y-disruptionpy)

- [66th APS-DPP Meeting (2024)](https://meetings.aps.org/Meeting/DPP24)
- AD Maris, _et al._ (2024), _"Correlation of the tokamak density limit with edge collisionality"_, [BI02.2](https://meetings.aps.org/Meeting/DPP24/Session/BI02.2)
- H Wietfeldt, _et al._ (2024), _"Discerning Why Some High-Z UFOs in C-Mod Caused Immediate Disruptions while Others Did Not"_, [NP12.111](https://meetings.aps.org/Meeting/DPP24/Session/NP12.111)
- GL Trevisan, _et al._ (2024), _"Functional Improvements and Technical Developments of a Community-driven and Physics-informed Numerical Library for Disruption Studies"_, [PP12.9](https://meetings.aps.org/Meeting/DPP24/Session/PP12.9)
- Y Wei, _et al._ (2024), _"Physics validation of parameter methods in DisruptionPy"_, [PP12.10](https://meetings.aps.org/Meeting/DPP24/Session/PP12.10)
- C Rea, _et al._ (2024), _"Open and FAIR Fusion for Machine Learning Applications"_, [PP12.27](https://meetings.aps.org/Meeting/DPP24/Session/PP12.27)
- AR Saperstein, _et al._ (2024), _"Development and preliminary calibration of an off-normal warning system for SPARC"_, [TO06.9](https://meetings.aps.org/Meeting/DPP24/Session/TO06.9)
- AD Maris, _et al._ (2024), _"Correlation of the tokamak density limit with edge collisionality"_, [BI02.2](https://meetings.aps.org/Meeting/DPP24/Session/BI02.2)
- H Wietfeldt, _et al._ (2024), _"Discerning Why Some High-Z UFOs in C-Mod Caused Immediate Disruptions while Others Did Not"_, [NP12.111](https://meetings.aps.org/Meeting/DPP24/Session/NP12.111)
- GL Trevisan, _et al._ (2024), _"Functional Improvements and Technical Developments of a Community-driven and Physics-informed Numerical Library for Disruption Studies"_, [PP12.9](https://meetings.aps.org/Meeting/DPP24/Session/PP12.9)
- Y Wei, _et al._ (2024), _"Physics validation of parameter methods in DisruptionPy"_, [PP12.10](https://meetings.aps.org/Meeting/DPP24/Session/PP12.10)
- C Rea, _et al._ (2024), _"Open and FAIR Fusion for Machine Learning Applications"_, [PP12.27](https://meetings.aps.org/Meeting/DPP24/Session/PP12.27)
- AR Saperstein, _et al._ (2024), _"Development and preliminary calibration of an off-normal warning system for SPARC"_, [TO06.9](https://meetings.aps.org/Meeting/DPP24/Session/TO06.9)

- [3rd IAEA Technical Meeting on Plasma Disruptions and their Mitigation (2024)](https://conferences.iaea.org/event/380/)
- AD Maris, _et al._ (2024), _"Correlation of the tokamak density limit with edge collisionality"_, [32301](https://conferences.iaea.org/event/380/contributions/32301/)
- AR Saperstein, _et al._ (2024), _"Development and preliminary calibration of an off-normal warning system for SPARC"_, [32305](https://conferences.iaea.org/event/380/contributions/32305/)
- AD Maris, _et al._ (2024), _"Correlation of the tokamak density limit with edge collisionality"_, [32301](https://conferences.iaea.org/event/380/contributions/32301/)
- AR Saperstein, _et al._ (2024), _"Development and preliminary calibration of an off-normal warning system for SPARC"_, [32305](https://conferences.iaea.org/event/380/contributions/32305/)

- [65th APS-DPP Meeting (2023)](https://meetings.aps.org/Meeting/DPP23)
- A Maris, _et al._ (2023), _"Data-driven tokamak density limit boundary identification"_, [BP11.108](https://meetings.aps.org/Meeting/DPP23/Session/BP11.108)
- L Spangher, _et al._ (2023), _"Do Fusion Plasma Time-Series Have a Persistent Memory that Machine Learning May Exploit?"_, [JP11.121](https://meetings.aps.org/Meeting/DPP23/Session/JP11.121)
- AR Saperstein, _et al._ (2023), _"Off-normal warning threshold development on SPARC"_, [JP11.123](https://meetings.aps.org/Meeting/DPP23/Session/JP11.123)
- Z Keith, _et al._ (2023), _"Risk-aware framework development for disruption prediction: Alcator C-Mod survival analysis"_, [JP11.124](https://meetings.aps.org/Meeting/DPP23/Session/JP11.124)
- A Maris, _et al._ (2023), _"Data-driven tokamak density limit boundary identification"_, [BP11.108](https://meetings.aps.org/Meeting/DPP23/Session/BP11.108)
- L Spangher, _et al._ (2023), _"Do Fusion Plasma Time-Series Have a Persistent Memory that Machine Learning May Exploit?"_, [JP11.121](https://meetings.aps.org/Meeting/DPP23/Session/JP11.121)
- AR Saperstein, _et al._ (2023), _"Off-normal warning threshold development on SPARC"_, [JP11.123](https://meetings.aps.org/Meeting/DPP23/Session/JP11.123)
- Z Keith, _et al._ (2023), _"Risk-aware framework development for disruption prediction: Alcator C-Mod survival analysis"_, [JP11.124](https://meetings.aps.org/Meeting/DPP23/Session/JP11.124)
Loading
Loading