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

Marked material_components for deprecation. #528

Merged
merged 16 commits into from
Sep 10, 2024
Merged

Conversation

MicahGale
Copy link
Collaborator

Description

See #504.

  • Adds deprecation doc strings
  • Started a migration page to describe the deprecation and the need for it.
  • Raised deprecation warnings with Material.material_components is accessed.

Fixes #506

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@MicahGale MicahGale self-assigned this Aug 29, 2024
@MicahGale MicahGale added documentation Improvements or additions to documentation code improvement labels Aug 29, 2024
@MicahGale MicahGale marked this pull request as ready for review August 29, 2024 22:07
@MicahGale
Copy link
Collaborator Author

MicahGale commented Aug 31, 2024

Should we switch from the term: Isotope to Nuclide? This is the terminology used by MCNP, and is meant to be all encompassing or isotopes, metastable isomers, and atomic data. For once I think I agree with their terminology.

We should deprecate Isotope here then.

@tjlaboss
Copy link
Collaborator

tjlaboss commented Sep 2, 2024

Yes. Nuclide is better for every reason.

Copy link
Collaborator

@tjlaboss tjlaboss left a comment

Choose a reason for hiding this comment

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

Changes so far look good

montepy/data_inputs/material.py Show resolved Hide resolved
doc/source/users.rst Outdated Show resolved Hide resolved
@MicahGale MicahGale merged commit 1f04794 into develop Sep 10, 2024
15 checks passed
@MicahGale MicahGale deleted the mat_deprecate branch September 10, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code improvement documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecation in support of material redesign
2 participants