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

Initial pip package. #380

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Conversation

joshua-cogliati-inl
Copy link
Collaborator

@joshua-cogliati-inl joshua-cogliati-inl commented Aug 5, 2024


Pull Request Description

What issue does this change request address?

Closes #379

What are the significant changes in functionality due to this change request?

This adds the files necessary to build a pip package to the repository (note that this probably only works on Mac and Linux because of the symbolic link).


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large tes.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
  • 9. If any test used as a basis for documentation examples have been changed, the associated documentation must be reviewed and assured the text matches the example.

@joshua-cogliati-inl
Copy link
Collaborator Author

@j-bryan Ping.

dylanjm
dylanjm previously approved these changes Sep 26, 2024
Copy link
Collaborator

@dylanjm dylanjm left a comment

Choose a reason for hiding this comment

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

Changes are good and allow us to build HERON whl anytime.

Copy link
Collaborator

@dylanjm dylanjm left a comment

Choose a reason for hiding this comment

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

Changes are approved with an additional README guiding users what commands to run to build the pip package.

@dylanjm dylanjm merged commit b9ac072 into idaholab:devel Sep 26, 2024
4 checks passed
@joshua-cogliati-inl joshua-cogliati-inl deleted the pip_package branch September 26, 2024 17:11
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.

[TASK] Include files needed to build pip package in repository
2 participants