alexbauer-pf commited on
Commit
7e3f47d
·
verified ·
1 Parent(s): 37a2ec0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -6
README.md CHANGED
@@ -682,11 +682,10 @@ misc.has_neurips_2025_forward_model_error
682
  ### Advanced Usage
683
  Install `constellaration` from [here](https://github.com/proximafusion/constellaration).
684
 
685
- Load, instantiate and plot plasma boundaries:
686
  ```python
687
  import datasets
688
  from constellaration.geometry import surface_rz_fourier
689
- from constellaration.utils import visualization
690
 
691
  full_json_ds = datasets.load_dataset("proxima-fusion/constellaration", "full_json")["train"]
692
  full_json_df = full_json_ds.to_pandas().set_index("plasma_config_id")
@@ -696,6 +695,8 @@ boundary = surface_rz_fourier.SurfaceRZFourier.model_validate_json(boundary_json
696
  ```
697
  Plot boundary:
698
  ```python
 
 
699
  visualization.plot_surface(boundary)
700
  visualization.plot_boundary(boundary)
701
  ```
@@ -706,7 +707,6 @@ Stream and instantiate the VMEC ideal MHD equilibria:
706
  ```python
707
  import datasets
708
  from constellaration.mhd import vmec_utils
709
- from constellaration.utils import visualization
710
 
711
  ds = datasets.load_dataset("proxima-fusion/constellaration", "vmecpp_ideal_mhd_equilibria", streaming=True)["train"]
712
 
@@ -719,10 +719,21 @@ vmecpp_wout = vmec_utils.VmecppWOut.model_validate_json(vmecpp_wout_json)
719
  plasma_config_id = batch["plasma_config_id"][0]
720
  boundary_json = full_json_df.loc[plasma_config_id]["boundary.surface"]
721
  boundary = surface_rz_fourier.SurfaceRZFourier.model_validate_json(boundary_json)
 
 
 
 
722
 
723
  visualization.plot_flux_surfaces(vmecpp_wout, boundary)
724
  ```
725
  ![Plot of flux surfaces](flux_surfaces.png)
 
 
 
 
 
 
 
726
 
727
  ## Dataset Structure
728
 
@@ -776,7 +787,7 @@ Proxima Fusion's stellarator optimization team.
776
 
777
  The dataset contains no personally identifiable information.
778
 
779
- ## Citation [optional]
780
 
781
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
782
 
@@ -784,7 +795,7 @@ The dataset contains no personally identifiable information.
784
 
785
  [not published yet]
786
 
787
- ## Glossary [optional]
788
 
789
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
790
 
@@ -798,7 +809,7 @@ The dataset contains no personally identifiable information.
798
  | NAE | Near-Axis Expansion |
799
  | NFP | Number of Field Periods |
800
 
801
- ## Dataset Card Authors [optional]
802
 
803
  Alexander Bauer, Santiago A. Cadena
804
 
 
682
  ### Advanced Usage
683
  Install `constellaration` from [here](https://github.com/proximafusion/constellaration).
684
 
685
+ Load and instantiate plasma boundaries:
686
  ```python
687
  import datasets
688
  from constellaration.geometry import surface_rz_fourier
 
689
 
690
  full_json_ds = datasets.load_dataset("proxima-fusion/constellaration", "full_json")["train"]
691
  full_json_df = full_json_ds.to_pandas().set_index("plasma_config_id")
 
695
  ```
696
  Plot boundary:
697
  ```python
698
+ from constellaration.utils import visualization
699
+
700
  visualization.plot_surface(boundary)
701
  visualization.plot_boundary(boundary)
702
  ```
 
707
  ```python
708
  import datasets
709
  from constellaration.mhd import vmec_utils
 
710
 
711
  ds = datasets.load_dataset("proxima-fusion/constellaration", "vmecpp_ideal_mhd_equilibria", streaming=True)["train"]
712
 
 
719
  plasma_config_id = batch["plasma_config_id"][0]
720
  boundary_json = full_json_df.loc[plasma_config_id]["boundary.surface"]
721
  boundary = surface_rz_fourier.SurfaceRZFourier.model_validate_json(boundary_json)
722
+ ```
723
+ Plot flux surfaces:
724
+ ```python
725
+ from constellaration.utils import visualization
726
 
727
  visualization.plot_flux_surfaces(vmecpp_wout, boundary)
728
  ```
729
  ![Plot of flux surfaces](flux_surfaces.png)
730
+ Save ideal MHD equilibrium to VMEC2000 WOut file:
731
+ ```python
732
+ import pathlib
733
+ from constellaration.utils import file_exporter
734
+
735
+ file_exporter.to_vmec2000_wout_file(vmecpp_wout, pathlib.Path("vmec2000_wout.nc"))
736
+ ```
737
 
738
  ## Dataset Structure
739
 
 
787
 
788
  The dataset contains no personally identifiable information.
789
 
790
+ ## Citation
791
 
792
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
793
 
 
795
 
796
  [not published yet]
797
 
798
+ ## Glossary
799
 
800
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
801
 
 
809
  | NAE | Near-Axis Expansion |
810
  | NFP | Number of Field Periods |
811
 
812
+ ## Dataset Card Authors
813
 
814
  Alexander Bauer, Santiago A. Cadena
815