Skip to content

Commit

Permalink
Remove syrupy section from docs (#2799)
Browse files Browse the repository at this point in the history
remove syrupy section from docs
  • Loading branch information
KasukabeDefenceForce authored Aug 16, 2024
1 parent 8a317dd commit 67c9cea
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions docs/contributing/development/running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,6 @@ Or, to run tests for a particular file or directory
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.


Running Syrupy Tests
======================
The tests module is currently being restructured to use `Syrupy <https://github.com/tophat/syrupy>`_.
These tests generate individual HDF(for Pandas) and ``.npy`` or ``.npz`` (for NumPy) files(or snapshots) for each test case.
For other objects, the plugin serialises them and saves them as ``.ambr`` files. There is a custom extension in the
main local `conftest <https://github.com/tardis-sn/tardis/blob/master/tardis/conftest.py>`_ file to get this to work.
The plugin currently only supports ``assert_allclose`` for NumPy and ``assert_series_equal`` and ``assert_frame_equal`` for
Pandas. Snapshots can be generated by using the same ``--generate-reference`` flag and are compared automatically.
You however need to provide the location to your snapshot directory using the ``--tardis-snapshot-data`` flag.
The snapshots are also saved in `tardis-sn/tardis-regressions <https://github.com/tardis-sn/tardis-regressions>`_.

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

Expand Down

0 comments on commit 67c9cea

Please sign in to comment.