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

Reorganizing Models #1454

Merged
merged 6 commits into from
Feb 17, 2021
Merged

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Feb 9, 2021

This pull request reorganizes the "Models" section of the documentation (docs/using/components/models/) to include all relevant files, make the files more organized, and get rid of redundancies.

Description

Changes include:

  • Moving each model into its own subdirectory under docs/using/components/models along with all relevant files used. This includes moving the files from docs/yml_files/densitycust into the the proper directory.
  • Merged .../models/examples/examples.rst, .../models/examples/index.rst, and .../models/examples/modelconfig.rst into .../models/index.rst to eliminate redundancies and extraneous files.
  • Included a link to run_simple_example.ipynb in .../models/examples/tardis_example.rst.
  • Deleted .../models/csy/csvy_test.ipynb.
  • Other small changes to fix warnings in the "Models" section of the documentation.

I organized this the way I thought it would work best. If that is not how it is supposed to be, please let me know. If you are reviewing this, you may want to take a look at that second bullet point to make sure no important information was lost.

Motivation and Context

This pull request addresses problems raised in issue #1437.

How Has This Been Tested?

  • Testing pipeline
  • Reference Data Comparison following these instructions
  • Other (please describe)

I built the documentation locally. The number of warnings decreased, and everything built as expected.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • None of the above (please describe)
    Documentation reorganization

Checklist:

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have built the documentation on my fork following these 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

@codecov
Copy link

codecov bot commented Feb 9, 2021

Codecov Report

Merging #1454 (8f204bc) into master (7f31e2b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1454   +/-   ##
=======================================
  Coverage   71.13%   71.13%           
=======================================
  Files          67       67           
  Lines        5523     5523           
=======================================
  Hits         3929     3929           
  Misses       1594     1594           

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 7f31e2b...e285394. Read the comment docs.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

Sorry it took me so long - I nearly forgot to review this. This looks great @smithis7 🎉

@andrewfullard andrewfullard merged commit 927c606 into tardis-sn:master Feb 17, 2021
@isaacgsmith isaacgsmith deleted the fixing_models branch June 1, 2021 14:54
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* reorganizing files

* fixing a few warnings

* moving some files around

* merging models/examples/examples, models/examples/index, and models/examples/modelconfig into models/index

* deleting models/csy/csv_test.ipynb

* changing header
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.

Include models examples in models index and reorganize models section
3 participants