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.

Sign up for GitHub

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

Jump to bottom

Remove syrupy section from docs #2799

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Remove syrupy section from docs #2799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions docs/contributing/development/running_tests.rst
View file
Open in desktop
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
Loading