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

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -11
README.md CHANGED
@@ -490,22 +490,25 @@ With the release of this dataset, we aim to lower the barrier for optimization a
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
- ### 1. `full_json`/`full_flat`
494
- Contains information about:
495
- - plasma boundaries
496
- - ideal MHD metrics
497
- - omnigenous field and targets, used as input for sampling of plasma boundaries
498
- - sampling settings for various methods ([DESC](https://desc-docs.readthedocs.io/en/stable/), [VMEC](https://github.com/proximafusion/vmecpp), QP initialization, Near-axis expansion)
499
- - Miscellaneous information about errors that might have occurred during sampling or metrics computation.
 
 
 
 
 
 
 
500
 
501
  The `full_json` variant of the dataset contains for each of the components listed about an identifier column (ending with `.id`), as well as a JSON column.
502
 
503
  The `full_flat` variant contains the same information as `full_json` but with all JSON columns flattened into one column per leaf in the nested JSON structure (with `.` separating the keys on the JSON path to the respective leaf).
504
 
505
- ### 2. `vmecpp_ideal_mhd_equilibria`
506
- Contain for each plasma boundary a JSON representations of the "WOut" file as obtained when running VMEC++ initialized on the boundary.
507
- The JSON representation can be converted to a VMEC2000 output file.
508
-
509
  ## Uses
510
 
511
  ### Basic Usage
 
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>
495
+ <th style="border-right: 1px solid gray;">full_json/full_flat</th>
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>
505
+
506
+ <br>
507
 
508
  The `full_json` variant of the dataset contains for each of the components listed about an identifier column (ending with `.id`), as well as a JSON column.
509
 
510
  The `full_flat` variant contains the same information as `full_json` but with all JSON columns flattened into one column per leaf in the nested JSON structure (with `.` separating the keys on the JSON path to the respective leaf).
511
 
 
 
 
 
512
  ## Uses
513
 
514
  ### Basic Usage