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.

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

#507: Deprecate LBAF-Viz and replace with calls to vt-tv #508

Merged

Conversation

cwschilly
Copy link
Contributor

@cwschilly cwschilly commented May 16, 2024

Fixes #507

PR #463 implements the vt-tv pipeline and removes the call to lbsVisualizer in LBAF_App.py.

@cwschilly cwschilly linked an issue May 16, 2024 that may be closed by this pull request
@cwschilly cwschilly marked this pull request as draft May 16, 2024 18:13
@ppebay ppebay self-requested a review May 17, 2024 20:10
Copy link
Contributor

@ppebay ppebay left a comment

Choose a reason for hiding this comment

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

When using some provided configuration files (e.g. conf.yaml), the following error occurs as expected, but it would be better to clean up all configuration decks in the conf directory, to ensure that they all indeed can be used as working examples

Traceback (most recent call last):
  File "/Users/pppebay/Documents/Git/LB-analysis-framework/src/lbaf/Applications/LBAF_app.py", line 605, in <module>
    LBAFApplication().run()
  File "/Users/pppebay/Documents/Git/LB-analysis-framework/src/lbaf/Applications/LBAF_app.py", line 574, in run
    visualizer = Visualizer(
  File "/Users/pppebay/Documents/Git/LB-analysis-framework/src/lbaf/IO/lbsVisualizer.py", line 47, in __init__
    raise DeprecationWarning("LBAF's Visualizer has been deprecated and will be removed in a future release. Visualizations should be generated with DARMA/vt-tv.`

Of course incorrect inputs can and should remain in the CI in order to test the above failure mode.

Copy link
Contributor

@ppebay ppebay left a comment

Choose a reason for hiding this comment

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

I suggest also adding an extra test in tests/unit/config with a configuration deck that contains, e.g., the following block:

visualization:
  x_ranks: 2
  y_ranks: 2
  z_ranks: 1
  object_jitter: 0.5
  rank_qoi: None
  object_qoi: None
  force_continuous_object_qoi: true
  output_visualization_dir: ../../output
  output_visualization_file_stem: output_file

in order to exercise the deprecation stop.

N.B.: this is not to replace the test_lbs_visualizer_deprecation.py in-code deprecation check, but in addition to it.

@cwschilly cwschilly force-pushed the 507-deprecate-lbaf-viz-and-replace-with-calls-to-vt-tv branch from 2278265 to 4238367 Compare May 21, 2024 20:03
@cwschilly cwschilly marked this pull request as ready for review May 21, 2024 20:49
@cwschilly cwschilly requested a review from ppebay May 21, 2024 20:49
Copy link
Contributor

@ppebay ppebay left a comment

Choose a reason for hiding this comment

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

Additional test is good

@cwschilly cwschilly merged commit ed0db06 into develop May 22, 2024
8 checks passed
@cwschilly cwschilly deleted the 507-deprecate-lbaf-viz-and-replace-with-calls-to-vt-tv branch May 22, 2024 12:51
github-actions bot pushed a commit that referenced this pull request May 22, 2024
* #507: add deprecate error to lbsVisualizer

* #507: add test for deprecation warning

* #507: remove all references to visualization in unit test config files

* #507: add newline

* #507: remove viz params from all config files

* #507: add config file test for lbaf viz deprecation

* #507: remove config file test; clean up viz deprecation

* #507: restore config test for viz deprecation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate LBAF-Viz and replace with calls to vt-tv
2 participants