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

Conversation

manas-dhyani
Copy link

@manas-dhyani manas-dhyani commented Feb 15, 2025

Documentation Update

This PR updates the Quickstart guide to document the log(g f) cutoff used in Carsus.

  • Default cutoff: -3
  • Users can modify it via "lines_loggf_threshold" inside levels_lines_param in TARDISAtomData.
  • Added an example demonstrating how to change the cutoff.
  • Explained how modifying this value affects the included spectral lines.
  • Fix: Corrected the broken "Notation in Carsus" link.

📌 Resources

🚦 Testing

  • No testing required as this is a documentation change.

☑️ Checklist

  • I updated the documentation according to my changes.
  • I built the documentation by applying the build_docs label.
  • I requested two reviewers for this pull request.

Closes #273.

-Default cutoff: `-3`
- Users can modify it via `"lines_loggf_threshold"` inside `levels_lines_param` in `TARDISAtomData`.
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Contributor

github-actions bot commented Feb 15, 2025

*beep* *bop*
Hi human,
I ran ruff on the latest commit (a182a1b).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

Complete output(might be large):

All checks passed!

Copy link
Contributor

github-actions bot commented Feb 15, 2025

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add option to change the log gf cut applied by carsus to the documentation
1 participant