Update README.md
Browse files
README.md
CHANGED
|
@@ -484,6 +484,28 @@ With the release of this dataset, we aim to lower the barrier for optimization a
|
|
| 484 |
- **Paper:** [not published yet]
|
| 485 |
- **Code:** https://github.com/proximafusion/constellaration
|
| 486 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 487 |
## Uses
|
| 488 |
|
| 489 |
### Basic Usage
|
|
@@ -664,7 +686,7 @@ from constellaration.utils import visualization
|
|
| 664 |
visualization.plot_flux_surfaces(vmecpp_wout, boundary)
|
| 665 |
```
|
| 666 |

|
| 667 |
-
Save ideal MHD equilibrium to VMEC2000 WOut file:
|
| 668 |
```python
|
| 669 |
import pathlib
|
| 670 |
from constellaration.utils import file_exporter
|
|
@@ -672,28 +694,6 @@ from constellaration.utils import file_exporter
|
|
| 672 |
file_exporter.to_vmec2000_wout_file(vmecpp_wout, pathlib.Path("vmec2000_wout.nc"))
|
| 673 |
```
|
| 674 |
|
| 675 |
-
## Dataset Structure
|
| 676 |
-
|
| 677 |
-
<!-- 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. -->
|
| 678 |
-
|
| 679 |
-
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.
|
| 680 |
-
|
| 681 |
-
### 1. `full_json`/`full_flat`
|
| 682 |
-
Contains information about:
|
| 683 |
-
- plasma boundaries
|
| 684 |
-
- ideal MHD metrics
|
| 685 |
-
- omnigenous field and targets, used as input for sampling of plasma boundaries
|
| 686 |
-
- sampling settings for various methods ([DESC](https://desc-docs.readthedocs.io/en/stable/), [VMEC](https://github.com/proximafusion/vmecpp), QP initialization, Near-axis expansion)
|
| 687 |
-
- Miscellaneous information about errors that might have occurred during sampling or metrics computation.
|
| 688 |
-
|
| 689 |
-
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.
|
| 690 |
-
|
| 691 |
-
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).
|
| 692 |
-
|
| 693 |
-
### 2. `vmecpp_ideal_mhd_equilibria`
|
| 694 |
-
Contain for each plasma boundary a JSON representations of the "WOut" file as obtained when running VMEC++ initialized on the boundary.
|
| 695 |
-
The JSON representation can be converted to a VMEC2000 output file.
|
| 696 |
-
|
| 697 |
## Dataset Creation
|
| 698 |
|
| 699 |
### Curation Rationale
|
|
@@ -730,7 +730,12 @@ The dataset contains no personally identifiable information.
|
|
| 730 |
|
| 731 |
**BibTeX:**
|
| 732 |
|
| 733 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 734 |
|
| 735 |
## Glossary
|
| 736 |
|
|
|
|
| 484 |
- **Paper:** [not published yet]
|
| 485 |
- **Code:** https://github.com/proximafusion/constellaration
|
| 486 |
|
| 487 |
+
## Dataset Structure
|
| 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 |
+
### 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
|
|
|
|
| 686 |
visualization.plot_flux_surfaces(vmecpp_wout, boundary)
|
| 687 |
```
|
| 688 |

|
| 689 |
+
Save ideal MHD equilibrium to *VMEC2000 WOut* file:
|
| 690 |
```python
|
| 691 |
import pathlib
|
| 692 |
from constellaration.utils import file_exporter
|
|
|
|
| 694 |
file_exporter.to_vmec2000_wout_file(vmecpp_wout, pathlib.Path("vmec2000_wout.nc"))
|
| 695 |
```
|
| 696 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 697 |
## Dataset Creation
|
| 698 |
|
| 699 |
### Curation Rationale
|
|
|
|
| 730 |
|
| 731 |
**BibTeX:**
|
| 732 |
|
| 733 |
+
@article{article_id,
|
| 734 |
+
author = {Santiago A Cadena, Andrea Merlo, Emanuel Laude, Alexander Bauer, Atul Agrawal, Maria Pascu, Marija Savtchouk, Lukas Bonauer, Enrico Guiraud, Stuart R. Hudson, Markus Kaiser},
|
| 735 |
+
title = {ConStellaration: A dataset of QI-like stellarator plasma boundaries and optimization benchmarks},
|
| 736 |
+
journal = {NeurIPS 2025 Datasets and Benchmarks Track},
|
| 737 |
+
year = {2025}
|
| 738 |
+
}
|
| 739 |
|
| 740 |
## Glossary
|
| 741 |
|