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

update doc page to a notebook #1153

Merged
merged 3 commits into from Jun 2, 2020
Merged

Conversation

sashank27
Copy link
Contributor

Updated physical quantitities page to a jupyter notebook

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

Review Jupyter notebook visual diffs & provide feedback on notebooks.


Powered by ReviewNB

Copy link
Contributor

@arjunsavel arjunsavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great change — I'm very much for having more notebooks in the documentation! A few clarifications regarding changes (these are probably fine, just wanted to check):

  • Does the information exist in radial1d or Simulation? Could they be accessed directly from radial1d?
  • Similarly regarding the change from accessing tardis_config to accessing model

One thing that I would add is mentioning the use of AstroPy Quantities for simulation.model.v_inner.cgs and related quantities.

Other than that, I'm ready to approve this.

@sashank27
Copy link
Contributor Author

@arjunsavel

Does the information exist in radial1d or Simulation? Could they be accessed directly from radial1d?

The physical quantities are mostly either in Radial1DModel or BasePlasma, both under Simulation. So I guess it would be better to use Simulation as a base to access these objects and then the subsequent params.

Similarly regarding the change from accessing tardis_config to accessing model

As mentioned by @chvogl in the chats, tardis_config is now removed from the Simulation and now these params are inside model

One thing that I would add is mentioning the use of AstroPy Quantities for simulation.model.v_inner.cgs and related quantities.

Okay, I will update that

@sashank27 sashank27 marked this pull request as ready for review June 1, 2020 18:33
Copy link
Contributor

@arjunsavel arjunsavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the changes!

@wkerzendorf wkerzendorf merged commit d829b1c into tardis-sn:master Jun 2, 2020
@arjunsavel arjunsavel moved this from In progress to Done in Documentation Jun 24, 2020
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* update doc page to a notebook

* fix errors

* mention units as Astropy Quantities wherever present
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants