Skip to content

Migrate Figure.inset tests to use dvc #1163

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

Merged
merged 8 commits into from
Apr 3, 2021
Merged

Migrate Figure.inset tests to use dvc #1163

merged 8 commits into from
Apr 3, 2021

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Apr 2, 2021

As discussed in #1131, this moves the reference figures in fig.inset to use dvc.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzer willschlitzer added skip-changelog Skip adding Pull Request to changelog maintenance Boring but important stuff for the core devs labels Apr 2, 2021
@willschlitzer willschlitzer added this to the 0.4.0 milestone Apr 2, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 2, 2021

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path
added pygmt/tests/baseline/test_inset_aliases.png
added pygmt/tests/baseline/test_inset_context_manager.png

Image diff(s)

  • pygmt/tests/baseline/test_inset_aliases.png

  • pygmt/tests/baseline/test_inset_context_manager.png

Report last updated at commit 85a365d

@willschlitzer willschlitzer marked this pull request as ready for review April 2, 2021 12:16
@willschlitzer willschlitzer self-assigned this Apr 2, 2021
@seisman
Copy link
Member

seisman commented Apr 2, 2021

This pull request keeps @check_figures_equal for test_inset_context_manager() as it is testing the use of the context manager.

I think we still should refactor this test.

@willschlitzer
Copy link
Contributor Author

willschlitzer commented Apr 2, 2021

This pull request keeps @check_figures_equal for test_inset_context_manager() as it is testing the use of the context manager.

I think we still should refactor this test.

What should I use for the reference image to test the context manager? Which part of the test should remain in the refactored test and which should be discarded?

@seisman
Copy link
Member

seisman commented Apr 2, 2021

Test that the inset context manager works and, once closed, plotting elements are added to the larger figure.

The main purpose of this test is to check if basemap(rose="jTR+w3c") plots the rose in the large figure, not in the inset map. So you can simply remove the reference image.

@willschlitzer
Copy link
Contributor Author

Test that the inset context manager works and, once closed, plotting elements are added to the larger figure.

The main purpose of this test is to check if basemap(rose="jTR+w3c") plots the rose in the large figure, not in the inset map. So you can simply remove the reference image.

Updated it to use a reference image.

@willschlitzer willschlitzer changed the title Migrate a fig.inset test to use dvc Migrate fig.inset tests to use dvc Apr 3, 2021
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Just need to remove the check_figures_equal import and it should be good to merge I think.

@seisman seisman changed the title Migrate fig.inset tests to use dvc Migrate Figure.inset tests to use dvc Apr 3, 2021
@seisman seisman merged commit 3414f69 into master Apr 3, 2021
@seisman seisman deleted the test-inset-dvc branch April 3, 2021 15:20
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants