Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document log(g f) cutoff option in TARDISAtomData (#273) #426

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion docs/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"\n",
"**Note:**\n",
"\n",
"Get familiar with the [Notation in Carsus](development/notation.rst) and learn how to correctly select ions.\n",
"Get familiar with the [Notation in Carsus](reference/notation.rst) and learn how to correctly select ions.\n",
" \n",
"</div>"
]
Expand Down Expand Up @@ -268,6 +268,40 @@
"You are done! Now you can use your file to run TARDIS simulations."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Controlling the log(g f) Cutoff in TARDISAtomData\n",
"\n",
"By default, Carsus applies a cutoff of **log(g f) = -3** when processing spectral lines. \n",
"This means transitions with log(g f) < -3 are excluded from the atomic data file.\n",
"\n",
"If you want to change this threshold, modify the `\"lines_loggf_threshold\"` value inside `levels_lines_param`:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"atom_data = TARDISAtomData(atomic_weights,\n",
" ionization_energies,\n",
" gfall_reader,\n",
" zeta_data,\n",
" chianti_reader,\n",
" cmfgen_reader,\n",
" levels_lines_param={\"lines_loggf_threshold\": -5}) # Example: Change cutoff to -5"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Setting lines_loggf_threshold to a lower value includes weaker transitions, while increasing it filters out more lines."
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
Loading