new documentation: using add_config_dict (#231)

* new documentation: using add_config_dict * better example graph --------- Co-authored-by: Joshua Shields <[email protected]>
tardis-sn · Dec 2, 2024 · 7bddf42 · 7bddf42
1 parent 4279f55
commit 7bddf42
Show file tree

Hide file tree

Showing 3 changed files with 193 additions and 0 deletions.
diff --git a/docs/Changing_Parameters/Changing_Param_Example.yml b/docs/Changing_Parameters/Changing_Param_Example.yml
@@ -0,0 +1,17 @@
+stardis_config_version: 1.0
+atom_data: kurucz_cd23_chianti_H_He.h5
+model:
+    type: marcs
+    fname: ../quickstart/sun.mod
+    final_atomic_number: 30
+opacity:
+    file: {}
+    bf:
+        H_I: {}
+    ff:
+        H_I: {}
+    disable_electron_scattering: False
+    line:
+        disable: False
+        broadening: [radiation, linear_stark, quadratic_stark, van_der_waals]
+no_of_thetas: 10
diff --git a/docs/Changing_Parameters/Changing_Parameters.ipynb b/docs/Changing_Parameters/Changing_Parameters.ipynb
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ This is the documentation for STARDIS.
    Possible STARDIS Outputs <possible_stardis_outputs/possible_stardis_outputs>
    Custom Star Model <Custom_Star_Model_with_Marcs/Custom_Star_Model_with_Marcs>
    Using STARDIS in Parallel <using_stardis_in_parallel/stardis_in_parallel>
+   Changing Parameters <Changing_Parameters/Changing_Parameters>
    Example Notebooks <example_notebooks/rotation_broadening>
    Contributing <contributing>
    Bibliography <bibliography>