Adding Interactive Initialization Documentation #1589
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #1589 +/- ##
=======================================
Coverage 61.92% 61.93%
=======================================
Files 62 62
Lines 5702 5729 +27
=======================================
+ Hits 3531 3548 +17
- Misses 2171 2181 +10
Continue to review full report at Codecov.
|
Fixed. I really need to put my writing into a spelling/grammar check program before I make a PR *insert facepalm emoji* |
|
Converted to draft until #1592 is merged so I can edit this notebook to reflect the changes to the code. |
andrewfullard
approved these changes
Jun 3, 2021
|
Before a PR is accepted, it must meet the following criteria:
|
isaacgsmith
force-pushed
the
initialization_doc
branch
from
1740a39 to
68a46b0
Compare
|
Before a pull request is accepted, it must meet the following criteria:
|
chvogl
requested changes
Jun 16, 2021
|
Try to use astropy units when instantiating quantities containing units to keep consistency with the way that constants are access from astropy. |
Rodot-
approved these changes
Jun 17, 2021
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* creating energypackets notebook * more additions to energypackets page * finished notebook aspect of energy packet docs * important small changes * wrote a section before the python code * final changes * fixing typos * a few changes * adding more info to the custom_source notebook * working on custom_source notebook * grammar * grammar in the notebook title * fixing typo * fixing hyperlink * fixing hyperlink again * pep 8 * more pep8 * formatting * getting opinions * adding units
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR creates interactive documentation on energy packet initialization.
Description
The new notebook incorporates the "Discretization" page and elements of the "Propagation" page of the documentation, as well as code that demonstrates how packets are initialized in TARDIS. This PR also fixes hyperlink problems that arose from my changes.
Motivation and context
This is part of a larger problem to make the TARDIS documentation more interactive.
How has this been tested?
The documentation has been built locally and on github (see below)
Examples
You can view the built documentation with my changes here.
Type of change
Checklist