29 describe materials #32
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes significant updates to the documentation for the materials and electron range functionalities in the
pyamtracklibrary. The updates provide comprehensive details on the material system and the electron range calculation function, along with examples and error handling.Documentation improvements:
docs/python/API/materials.md: Added detailed documentation for the material system, including properties, predefined materials, and usage examples.docs/python/API/stopping/electron_range.md: Added detailed documentation for theelectron_rangefunction, including input parameters, available models, example usage, and error handling.Status updates:
docs/python/function-status.md: Updated the status of thematerialsmodule and thestopping.electron_rangefunction to indicate they are fully ported. [1] [2]