Skip to content

Update README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fcasson wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db7c6e3
Update README.md
fcasson Jan 9, 2026
d620a20
Update README.md
fcasson Jan 9, 2026
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This design milestone is variously known as SPR45, SPP-001, and CML5.
It does not necessarily reflect the current or future state of the STEP programme.

The data is provided in [IMAS data entries](https://imas-data-dictionary.readthedocs.io/en/latest/) containing IMAS data structures (IDSs).
Two formats are provided: `*/imasdb/*`, entries written with the HDF5 Access Layer (not currently open source), and `*/STEP_SPP_001_*.nc`, NetCDF5 entries readable with [IMAS-Python](https://imas-python.readthedocs.io/en/stable/netcdf.html) (open source).
Two formats are provided: `*/imasdb/*`, entries written with the [IMAS Access Layer](https://imas-core.readthedocs.io/en/latest/user_guide/index.html) using the HDF5 backend, and `*/STEP_SPP_001_*.nc`, NetCDF5 entries readable directly with [IMAS-Python](https://imas-python.readthedocs.io/en/stable/netcdf.html). Both formats may be read with open source IMAS software components (though the installation and dependencies of the latter are lighter).

## Contents

Expand All @@ -35,6 +35,12 @@ Note that free boundary equilibrium is only available for the EB-CC scenario, wh

SimDB aliases and UUIDs are provided for internal provenance tracking.

## Sign conventions and file formats

* IMAS output (Data Dictionary version 3) is [COCOS 11](https://imas-data-dictionary.readthedocs.io/en/latest/cocos.html#cocos)
* Eqdsk output is COCOS 1 (consistent with [original definition](https://w3.pppl.gov/ntcc/TORAY/G_EQDSK.pdf))
* JETTO native output (`jetto.jsp`, `jetto.jst,` etc) is COCOS 2 and may be read into python with [jetto-tools](https://pypi.org/project/jetto-tools/).

## Sources and citing

To cite this release, please use the following:
Expand Down