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

Add Catalyst Plugin. #496

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

francois-kitware
Copy link

@francois-kitware francois-kitware commented Nov 8, 2024

Add the catalyst plugin developed by Kitware as an official PDI plugin.

The plugin code have been copied in the branch and the catalyst library dependency is added as a submodule for easy update in the future.

When built with BUILD_TESTING CMake variable, the pdi-catalyst-plugin tests should pass:

$ ctest -R Catalyst                                             
Test project /home/francois/Documents/Numpex/PDI/github/build                                  
    Start 1417: TestPDICatalyst  
1/2 Test #1417: TestPDICatalyst ..................   Passed    3.18 sec                        
    Start 1418: TestPDICatalystMPI
2/2 Test #1418: TestPDICatalystMPI ...............   Passed    1.61 sec 

Looks like lots of boxes below are not checked. I'll update everything after PDI's team code review.

François

List of things to check before making a PR

Before merging your code, please check the following:

  • you have added a line describing your changes to the Changelog;
  • you have added unit tests for any new or improved feature;
  • In case you updated dependencies, you have checked pdi/docs/CheckList.md
  • you have checked your code format:
    • you have checked that you respect all conventions specified in CONTRIBUTING.md;
    • you have checked that the indentation and formatting conforms to the .clang-format;
    • you have documented with doxygen any new or changed function / class;
  • you have correctly updated the copyright headers:
    • your institution is in the copyright header of every file you (substantially) modified;
    • you have checked that the end-year of the copyright there is the current one;
  • you have updated the AUTHORS file:
    • you have added yourself to the AUTHORS file;
    • if this is a new contribution, you have added it to the AUTHORS file;
  • you have added everything to the user documentation:
    • any new CMake configuration option;
    • any change in the yaml config;
    • any change to the public or plugin API;
    • any other new or changed user-facing feature;
    • any change to the dependencies;
  • you have correctly linked your MR to one or more issues:
    • your MR solves an identified issue;
    • your commit contain the Fix #issue keyword to autoclose the issue when merged.

@jbigot jbigot linked an issue Nov 27, 2024 that may be closed by this pull request
Copy link
Member

@jbigot jbigot left a comment

Choose a reason for hiding this comment

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

Can you also add Kitware to the copyright at the top of the root CMakeLists.txt you contributed to

@jbigot
Copy link
Member

jbigot commented Dec 11, 2024

Thank you so much for the contribution @francois-kitware !

From our point of view, it's basically good to go as-is, if you maintain the plugin separately in a submodule. We just need to add a Changelog entry, and some other minor elements related to our "checkboxes".

Would you also be interested in the review of the plugin code? In this case, this should be done on your gitlab since from github we only have a submodule reference.

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.

Plugin Catalyst
2 participants