Creating new docs building instructions #2097
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
isaacgsmith
requested review from
atharva-2001,
epassaro,
jaladh-singhal and
AlexHls
and removed request for
atharva-2001
Codecov Report
@@ Coverage Diff @@
## master #2097 +/- ##
=======================================
Coverage 58.13% 58.13%
=======================================
Files 75 75
Lines 8602 8602
=======================================
Hits 5001 5001
Misses 3601 3601 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
isaacgsmith
changed the title
|
*beep* *bop* Hi, human. The Click here to see your results. |
AlexHls
approved these changes
Jul 18, 2022
jaladh-singhal
approved these changes
Jul 18, 2022
jayantbhakar
pushed a commit
to jayantbhakar/tardis
that referenced
this pull request
Jul 29, 2022
* creating new docs building instructions * typos, grammar, and text in hyperlinks
andrewfullard
pushed a commit
that referenced
this pull request
Aug 3, 2022
* rpacket_tracker returns dataframe * added black formatting * replaced variable i * added rpacket_tracker_df as separate variable * added preallocation step * added non-preallocated-df generator function * tests for df generator function * renamed variables * assert statements corrected * added seed column in df * added documentation for rpacket_tracker_df * added doc str * initial commit * updated documention * moved function to r_packet.py * added block indexing to df Co-authored-by: Wolfgang Kerzendorf <[email protected]> * updated the df function * added multiindexing * shifted the df function call * initial commit * interaction type added * removed unused imports * added tests * initial commit * interaction type added * Created a smart HDF Reader which can re-produce simulation object (#2052) * Added functions to store and load a runner object * Updated hardcode file name in runner_from_hdf * Updated store_runner_to_hdf to append to file * Added name and email to .mailmap * runner hdf functions convert to cgs * store_runner_to_hdf clears group before storing * Storing units for astropy quantities * Formatted code with black * Added functions to store and load model objects * Fixed typo and decoded string from bytes * Fixed typo * Added test for model_to_dict * Formatted previous test code * Added test for store_model_to_hdf * Fixed formatting of model_to_hdf * Fixed issue with test for model_to_dict * Added test for runner_to_dict * Fixed issue with single packet seed storage * Updated test null value of single packet seed * Added test for store_runner_to_hdf * Updated to use isinstance and hasattr * runner_to_dict returns dicts instead of iterators * Reordered imports to match pep8 style * Remove yaml_load_config_file (#2062) * Remove yaml_load_config_file * updated mailmap * Updated __init__.py * Modified Function Name in Config validator according to PEP8 (#2076) Fix function name according pep8 * Added documetation on how to compare environment before update (#2082) * Moved `trace_packet` to tardis tansport (#2083) * Moved the trace_packet function to the transport module, renamed the function to remove continuum reference as it is generic * Formatted to PEP 8 * Reformatted single_packet_loop for PEP 8 * removed old continuum trace packet files * removed references to old files * Added some docstrings * Missed an old function call * Fix broken links in workflow files and goverance md (#2084) * Adding physics introduction to documentation (#2026) * creating files and sections * adding images * writing intro to tardis physics and adding it to sidebar * changing spectra page structure * mostly complete draft of light and matter page * spectrum page * fixing up physics stuff * fixing docstring * Revert "fixing docstring" This reverts commit e24cadd. * andrew's changes * a few more edits * adding note about angstroms * Improved arepo parser (#1941) * Removed line profile as option * Removed mapping to Cartesian grid * Removed automatic plotting after profile creation * Fixed typo in arepo plot * Updated documentation * [build docs] * [build docs] Removed outputs from doc-notebook * Updated tests with new models * Removed deprecated keyword in snapshot loader * Replaced wget with requests for testfile download * Updated file retrieval for testing * Fixed fixture request * Added arepo data to refdata helper * Updated refdata location in docs * Updated paths in tests * Update download_reference_data.sh * Testing areop_parser_tests * Fixed deleted reference file * Arepo docs fix (#2088) * [build-docs] Fixed link in arepo docs * [build-docs] Changed filename in arepo docs * [build-docs] * [build-docs] * [build-docs] * [build docs] * [build-docs] Changed refdata url * [build_docs] * Updated mailmap * [build_docs] Updated url for refdata download * Creating new docs building instructions (#2097) * creating new docs building instructions * typos, grammar, and text in hyperlinks * added tests * added documentation, black formatting Co-authored-by: Wolfgang Kerzendorf <[email protected]> Co-authored-by: Satwik Kambham <[email protected]> Co-authored-by: aman kumar <[email protected]> Co-authored-by: Rohith Varma Buddaraju <[email protected]> Co-authored-by: Jaladh Singhal <[email protected]> Co-authored-by: Jack O'Brien <[email protected]> Co-authored-by: Isaac Smith <[email protected]> Co-authored-by: AlexHls <[email protected]>
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.
📝 Description
Type: 📝
documentationAdds updated instructions for building documentation on GitHub.
Closes #2089.
📌 Resources
See the docs: https://tardis-sn.github.io/tardis/pull/2097/contributing/development/documentation_guidelines.html
🚦 Testing
How did you test these changes?
Docs built on GitHub.
☑️ Checklist
build_docslabel