alexbauer-pf commited on
Commit
29fe948
·
verified ·
1 Parent(s): 2882e99

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -5
README.md CHANGED
@@ -488,7 +488,7 @@ With the release of this dataset, we aim to lower the barrier for optimization a
488
 
489
  <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
490
 
491
- The dataset consists of 2 tabular parts. Both parts have a column `plasma_config_id` in common which can be used to associate respective entries.
492
 
493
  <table>
494
  <tr>
@@ -496,9 +496,17 @@ The dataset consists of 2 tabular parts. Both parts have a column `plasma_config
496
  <th>vmecpp_ideal_mhd_equilibria</th>
497
  </tr>
498
  <tr>
499
- <td style="border-right: 1px solid gray;">• Plasma boundaries<br>• Ideal MHD metrics<br>• Omnigenous field and targets, used as input for sampling of plasma boundaries<br>• Sampling settings for various methods ([DESC](https://desc-docs.readthedocs.io/en/stable/), [VMEC](https://github.com/proximafusion/vmecpp), QP initialization, Near-axis expansion)<br>• Miscellaneous information about errors that might have occurred during sampling or metrics computation.
 
 
 
 
 
 
 
 
500
  </td>
501
- <td>Contains for each plasma boundary a JSON representations of the "WOut" file as obtained when running VMEC, initialized on the boundary.<br>The JSON representation can be converted to a VMEC2000 output file.
502
  </td>
503
  </tr>
504
  </table>
@@ -748,8 +756,8 @@ The dataset contains no personally identifiable information.
748
  | -------- | ------- |
749
  | QI | Quasi-Isodynamic(ity) |
750
  | MHD | Magneto-Hydrodynamic |
751
- | DESC | Dynamical Equilibrium Solver for Confinement |
752
- | VMEC | Variational Moments Equilibrium Code |
753
  | QP | Quasi-Poloidal |
754
  | NAE | Near-Axis Expansion |
755
  | NFP | Number of Field Periods |
 
488
 
489
  <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
490
 
491
+ The dataset consists of 2 tabular parts. Both parts have a column `plasma_config_id` in common which can be used to associate respective entries:
492
 
493
  <table>
494
  <tr>
 
496
  <th>vmecpp_ideal_mhd_equilibria</th>
497
  </tr>
498
  <tr>
499
+ <td style="border-right: 1px solid gray;">
500
+ Contains information about:
501
+ <ul>
502
+ <li>Plasma boundaries</li>
503
+ <li>Ideal MHD metrics</li>
504
+ <li>Omnigenous field and targets, used as input for sampling of plasma boundaries</li>
505
+ <li>Sampling settings for various methods (DESC, VMEC, QP initialization, Near-axis expansion)</li>
506
+ <li>Miscellaneous information about errors that might have occurred during sampling or metrics computation.</li>
507
+ </ul>
508
  </td>
509
+ <td>Contains, for each plasma boundary, a JSON representations of the "WOut" file as obtained when running VMEC, initialized on the boundary.<br>The JSON representation can be converted to a VMEC2000 output file.
510
  </td>
511
  </tr>
512
  </table>
 
756
  | -------- | ------- |
757
  | QI | Quasi-Isodynamic(ity) |
758
  | MHD | Magneto-Hydrodynamic |
759
+ | [DESC](https://desc-docs.readthedocs.io/en/stable/) | Dynamical Equilibrium Solver for Confinement |
760
+ | VMEC/[VMEC++](https://github.com/proximafusion/vmecpp) | Variational Moments Equilibrium Code (Fortran/C++) |
761
  | QP | Quasi-Poloidal |
762
  | NAE | Near-Axis Expansion |
763
  | NFP | Number of Field Periods |