Skip to content

Commit

Permalink
Add documentation for LFS caching, The Bridge and Save Atomic Files W…
Browse files Browse the repository at this point in the history
…orkflow (#2288)

* Cache LFS docs [build docs]

* Remove brackets

* Documentation for bridge and save-atomic-files workflows

* rerun workflow
  • Loading branch information
atharva-2001 authored Sep 8, 2023
1 parent f5cfd50 commit dffac0a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/contributing/development/continuous_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,3 +353,22 @@ Finally, the report is uploaded to the
following the ``<pr>/<commit>`` folder structure. If the pipeline fails, also a report is
generated, but not necessarily gives useful debug information (depends on which step the
pipeline has failed).


TARDIS Carsus Compatibility Check
=================================
The TARDIS Carsus Compatibility Check or the "Bridge" compares reference data
generated with different versions of Carsus. It consists of two jobs- a "carsus-build" job to
generate an atomic file with the latest version of Carsus and a "tardis-build" job
to generate a new reference data with it. These two reference data files are compared using the
`this notebook <https://github.com/tardis-sn/tardis-refdata/blob/master/notebooks/ref_data_compare_from_paths.ipynb>`_.
The workflow has a ``workflow_dispatch`` event so that it can be triggered manually, but is also
triggered every week due to the "save-atomic-files" workflow.


The Save Atomic Files Workflow
==============================
The Save Atomic Files workflow runs every week but can also be triggered manually.
It runs the "Bridge" and sends an artifact containing the generated atomic data file
and the comparison notebook to Moria. This workflow has a separate job to indicate if the
bridge has failed.
10 changes: 10 additions & 0 deletions docs/contributing/development/running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ Or, to run tests for a particular file or directory
> pytest tardis/path/to/test_file_or_directory --tardis-refdata=/path/to/tardis-refdata/
.. warning::
The `tests workflow <https://github.com/tardis-sn/tardis/blob/master/.github/workflows/tests.yml>`_ runs on
`pull requests <https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request>`_ and on
`push <https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push>`_ events.
To prevent leaking LFS quota, tests have been disabled on forks.
If, by any chance, you need to run tests on your fork, make sure to run the tests workflow on master branch first.
The LFS cache generated in the master branch should be available in all child branches.
You can check if cache was generated by looking in the ``Restore LFS Cache`` step of the workflow run.
Cache can also be found under the "Management" Section under "Actions" tab.

Generating Plasma Reference
===========================

Expand Down

0 comments on commit dffac0a

Please sign in to comment.