Update README.md

README.md

@@ -216,40 +216,56 @@ dataset_info:
     dtype: int64
   - name: omnigenous_field_and_targets.omnigenous_field.torodial_winding
     dtype: int64
-  - name: omnigenous_field_and_targets.omnigenous_field.modB_spline_knot_coefficients
+  - name: >-
+      omnigenous_field_and_targets.omnigenous_field.modB_spline_knot_coefficients
     sequence:
       sequence: float64
   - name: desc_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.target_kind
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eta_weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eta_weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_rho
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_rho
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_M_factor
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_M_factor
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_N_factor
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_N_factor
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.target_kind
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.target_kind
     dtype: string
   - name: desc_omnigenous_field_optimization_settings.optimizer_settings.name
     dtype: string
@@ -261,39 +277,55 @@ dataset_info:
     dtype: string
   - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.psi
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.dapper_type
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.dapper_type
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.check_orientation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.check_orientation
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.max_poloidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.max_poloidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.max_toroidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.max_toroidal_mode
     dtype: float64
   - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.torsion
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.elongation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.elongation
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.dapper_type
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.dapper_type
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.aspect_ratio
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.aspect_ratio
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.major_radius
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.major_radius
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.mirror_ratio
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.mirror_ratio
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.n_field_periods
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.n_field_periods
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.is_iota_positive
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.is_iota_positive
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.is_stellarator_symmetric
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.is_stellarator_symmetric
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_elongation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_elongation
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_poloidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_poloidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_toroidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_toroidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.rotational_transform
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.rotational_transform
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.verbose
     dtype: bool
@@ -305,17 +337,21 @@ dataset_info:
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.infinity_norm_spectrum_scaling
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.gradient_free_budget_per_design_variable
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_free_budget_per_design_variable
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.use_continuation_method_in_fourier_space
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.use_continuation_method_in_fourier_space
     dtype: bool
-  - name: vmec_omnigenous_field_optimization_settings.gradient_free_optimization_hypercube_bounds
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_free_optimization_hypercube_bounds
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.id
     dtype: string
   - name: vmec_omnigenous_field_optimization_settings.gradient_free_max_time
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.gradient_based_relative_objectives_tolerance
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_based_relative_objectives_tolerance
     dtype: float64
   - name: qp_init_omnigenous_field_optimization_settings.torsion
     dtype: float64
@@ -585,40 +621,56 @@ dataset_info:
     dtype: int64
   - name: omnigenous_field_and_targets.omnigenous_field.torodial_winding
     dtype: int64
-  - name: omnigenous_field_and_targets.omnigenous_field.modB_spline_knot_coefficients
+  - name: >-
+      omnigenous_field_and_targets.omnigenous_field.modB_spline_knot_coefficients
     sequence:
       sequence: float64
   - name: desc_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.elongation_settings.target_kind
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eta_weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eta_weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_rho
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_rho
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_M_factor
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_M_factor
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_N_factor
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.omnigenity_settings.eq_lcfs_grid_N_factor
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.aspect_ratio_settings.target_kind
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.name
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.name
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.weight
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.weight
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.target_kind
+  - name: >-
+      desc_omnigenous_field_optimization_settings.objective_settings.rotational_transform_settings.target_kind
     dtype: string
   - name: desc_omnigenous_field_optimization_settings.optimizer_settings.name
     dtype: string
@@ -628,35 +680,49 @@ dataset_info:
     dtype: float64
   - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.psi
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.check_orientation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.check_orientation
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.max_poloidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.max_poloidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.equilibrium_settings.max_toroidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.equilibrium_settings.max_toroidal_mode
     dtype: float64
   - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.torsion
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.elongation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.elongation
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.aspect_ratio
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.aspect_ratio
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.major_radius
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.major_radius
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.mirror_ratio
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.mirror_ratio
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.n_field_periods
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.n_field_periods
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.is_iota_positive
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.is_iota_positive
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.is_stellarator_symmetric
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.is_stellarator_symmetric
     dtype: bool
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_elongation
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_elongation
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_poloidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_poloidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.max_toroidal_mode
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.max_toroidal_mode
     dtype: float64
-  - name: desc_omnigenous_field_optimization_settings.initial_guess_settings.rotational_transform
+  - name: >-
+      desc_omnigenous_field_optimization_settings.initial_guess_settings.rotational_transform
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.verbose
     dtype: bool
@@ -670,13 +736,17 @@ dataset_info:
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.infinity_norm_spectrum_scaling
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.gradient_free_budget_per_design_variable
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_free_budget_per_design_variable
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.use_continuation_method_in_fourier_space
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.use_continuation_method_in_fourier_space
     dtype: bool
-  - name: vmec_omnigenous_field_optimization_settings.gradient_free_optimization_hypercube_bounds
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_free_optimization_hypercube_bounds
     dtype: float64
-  - name: vmec_omnigenous_field_optimization_settings.gradient_based_relative_objectives_tolerance
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.gradient_based_relative_objectives_tolerance
     dtype: float64
   - name: vmec_omnigenous_field_optimization_settings.id
     dtype: string
@@ -768,19 +838,23 @@ dataset_info:
     dtype: string
   - name: desc_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: desc_omnigenous_field_optimization_settings.desc_omnigenous_field_optimization_settings
+  - name: >-
+      desc_omnigenous_field_optimization_settings.desc_omnigenous_field_optimization_settings
     dtype: string
   - name: vmec_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: vmec_omnigenous_field_optimization_settings.vmec_omnigenous_field_optimization_settings
+  - name: >-
+      vmec_omnigenous_field_optimization_settings.vmec_omnigenous_field_optimization_settings
     dtype: string
   - name: qp_init_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: qp_init_omnigenous_field_optimization_settings.qp_init_omnigenous_field_optimization_settings
+  - name: >-
+      qp_init_omnigenous_field_optimization_settings.qp_init_omnigenous_field_optimization_settings
     dtype: string
   - name: nae_init_omnigenous_field_optimization_settings.id
     dtype: string
-  - name: nae_init_omnigenous_field_optimization_settings.nae_init_omnigenous_field_optimization_settings
+  - name: >-
+      nae_init_omnigenous_field_optimization_settings.nae_init_omnigenous_field_optimization_settings
     dtype: string
   - name: misc.vmecpp_wout_id
     dtype: string
@@ -1039,4 +1113,153 @@ configs:
   data_files:
   - split: train
     path: vmecpp_ideal_mhd_equilibria/part-*
+license: mit
+language:
+- en
+tags:
+- physics
+- fusion
+- optimization
+- surrogate
+- neurips
+pretty_name: ConStellaration
+size_categories:
+- 10K<n<100K
 ---
+# Dataset Card for Dataset Name
+
+<!-- Provide a quick summary of the dataset. -->
+
+This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+
+
+- **Curated by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+[More Information Needed]
+
+## Dataset Structure
+
+<!-- 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. -->
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+[More Information Needed]
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+[More Information Needed]
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+[More Information Needed]
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Dataset Card Authors [optional]
+
+[More Information Needed]
+
+## Dataset Card Contact
+
+[More Information Needed]