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

Adding Convergence Plots to the Documentation #1753

Merged
merged 3 commits into from
Jul 29, 2021

Conversation

atharva-2001
Copy link
Member

@atharva-2001 atharva-2001 commented Jul 23, 2021

This PR adds convergence plots to TARDIS documentation.

Description

This PR adds convergence plots notebook to the toctree, clears its output and changes the note section.

Motivation and context

How has this been tested?

  • Testing pipeline.
  • Other.

Examples

Link to the documentation
Link to the convergence plots notebook in the documentation
Link to the visualization page

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jul 23, 2021

Codecov Report

Merging #1753 (4eb65a4) into master (313f131) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1753   +/-   ##
=======================================
  Coverage   62.45%   62.45%           
=======================================
  Files          64       64           
  Lines        5985     5985           
=======================================
  Hits         3738     3738           
  Misses       2247     2247           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 313f131...4eb65a4. Read the comment docs.

Copy link
Member

@isaacgsmith isaacgsmith left a comment

Choose a reason for hiding this comment

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

Make sure you clear the output in the quickstart notebook

@jaladh-singhal jaladh-singhal merged commit c2d0b0a into tardis-sn:master Jul 29, 2021
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 1, 2021
* Add convergence_plots notebook to toctree

* Clear output in convergence_plots notebook

* [build docs]
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 9, 2021
* Add convergence_plots notebook to toctree

* Clear output in convergence_plots notebook

* [build docs]
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 9, 2021
* Add convergence_plots notebook to toctree

* Clear output in convergence_plots notebook

* [build docs]
atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* Add convergence_plots notebook to toctree

* Clear output in convergence_plots notebook

* [build docs]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants