-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ac5986b
commit fd23708
Showing
6 changed files
with
124 additions
and
106 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,97 +10,41 @@ resource provided by the esteemed Pacific Northwest National Laboratory | |
| necessary tools to access material properties crucial for accurate | ||
| simulation within various radiation transport codes. | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <script language="javascript"> | ||
| function pyneToggle(title, showHideDiv, switchTextDiv) { | ||
| var ele = document.getElementById(showHideDiv); | ||
| var text = document.getElementById(switchTextDiv); | ||
| if(ele.style.display == "block") { | ||
| ele.style.display = "none"; | ||
| text.innerHTML = title + " [+]"; | ||
| } | ||
| else { | ||
| ele.style.display = "block"; | ||
| text.innerHTML = title + " [-]"; | ||
| } | ||
| } | ||
| </script> | ||
|
|
||
| <div id="pynemenuheader"> | ||
| <a id="startHeader" | ||
| href="javascript:pyneToggle('Getting Started', 'startContent', 'startHeader');"> | ||
| Getting Started [+]</a> | ||
| </div> | ||
| <div style="clear:both;"></div> | ||
| <div id="pynemenucontent"> | ||
| <div id="startContent" style="display:none;"> | ||
| <ul> | ||
| <li><a href="install/index.html">Install</a></li> | ||
| <li><a href="examples/materials-compendium.html">Example</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <br /> | ||
| <div id="pynemenuheader"> | ||
| <a id="usingHeader" | ||
| href="javascript:pyneToggle('Using PyNE', 'usingContent', 'usingHeader');"> | ||
| Using Materails Compendium [+]</a> | ||
| </div> | ||
| <div style="clear:both;"></div> | ||
| <div id="pynemenucontent"> | ||
| <div id="usingContent" style="display:none;"> | ||
| <ul> | ||
| <li><a href="usersguide/index.html">User's Guide</a></li> | ||
| <li><a href="api/index.html">API Documentation</a></li> | ||
| <li><a href="mailto:[email protected]?subject=Subscribe&body=Send this message to subscribe to the list">Join</a> the <a href="https://groups.google.com/forum/#!forum/pyne-users" target="_blank"> Users</a> mailing list. | ||
| <li><a href="https://github.com/pyne/materials-compendium/issues">Report an Issue</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <br /> | ||
| <div id="pynemenuheader"> | ||
| <a id="contributeHeader" | ||
| href="javascript:pyneToggle('Contribute', 'contributeContent', 'contributeHeader');"> | ||
| Contribute [+]</a> | ||
| </div> | ||
| <div style="clear:both;"></div> | ||
| <div id="pynemenucontent"> | ||
| <div id="contributeContent" style="display:none;"> | ||
| <ul> | ||
| <li><a href="https://pyne.io/devsguide/index.html">Developer's Guide</a></li> | ||
| <li><a href="http://github.com/pyne/materials-compendium">Source Code</a></li> | ||
| <li><a href="mailto:[email protected]?subject=Subscribe&body=Send this message to subscribe to the list">Join</a> the | ||
| <a href="https://groups.google.com/forum/#!forum/pyne-users" target="_blank">Developers</a> mailing list. | ||
| <li><a href="https://pyne.io/dev_team.html">The PyNE Team</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <br /> | ||
| <div id="pynemenuheader"> | ||
| <a id="learnHeader" | ||
| href="javascript:pyneToggle('Learn More', 'learnContent', 'learnHeader');"> | ||
| Learn More [+]</a> | ||
| </div> | ||
| <div style="clear:both;"></div> | ||
| <div id="pynemenucontent"> | ||
| <div id="learnContent" style="display:none;"> | ||
| <ul> | ||
| <li><a href="https://pyne.io/theorymanual/index.html">Theory Manual</a></li> | ||
| <li><a href="https://pyne.io/pubs.html">Publications</a></li> | ||
| <li><a href="previous/index.html">Release Notes</a></li> | ||
| <li><a href="https://pyne.io/gsoc/index.html">Project Ideas</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| api/index | ||
| .. only:: html | ||
|
|
||
| .. grid:: 2 | ||
|
|
||
| .. grid-item-card:: \ :octicon:`book;2em` User's Guide | ||
| :text-align: center | ||
| :link: user/index | ||
| :link-type: doc | ||
|
|
||
| The user's guide contains instructions for installing and an overview of | ||
| the basic concepts. | ||
|
|
||
| .. grid-item-card:: \ :octicon:`repo;2em` Tutorial | ||
| :text-align: center | ||
| :link: tutorial/materials-compendium | ||
| :link-type: doc | ||
|
|
||
| The tutorial provides an introduction to using the Materials Compendium package. | ||
|
|
||
| .. grid:: 2 | ||
|
|
||
| .. grid-item-card:: \ :octicon:`terminal;2em` API Reference | ||
| :text-align: center | ||
| :link: api/index | ||
| :link-type: doc | ||
|
|
||
| The reference guide provides detailed information on classes, methods, | ||
| arguments, return values, etc. | ||
|
|
||
| .. grid-item-card:: \ :octicon:`comment-discussion;2em` Getting Help | ||
| :text-align: center | ||
| :link: https://github.com/pyne/materials-compendium/discussions | ||
|
|
||
| Have questions? Click here for our discussions forum. | ||
|
|
||
|
|
||
| .. _GitHub project site: https://github.com/pyne | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| .. _user: | ||
|
|
||
| Materials Compendium | ||
| ==================== | ||
|
|
||
| The **Materials Compendium** package facilitates the parsing of | ||
| essential material composition data from the “Compendium of Material | ||
| Composition Data for Radiation Transport Modeling,” a comprehensive | ||
| resource provided by the esteemed Pacific Northwest National Laboratory | ||
| (PNNL). This package equips radiation transport modelers with the | ||
| necessary tools to access material properties crucial for accurate | ||
| simulation within various radiation transport codes. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| Installation from PyPI | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| To integrate the **Materials Compendium** package seamlessly into your | ||
| workflow, you can use the `Python Package | ||
| Index <https://pypi.org/project/materials-compendium/>`__ using ``pip`` | ||
| command: | ||
|
|
||
| .. code:: sh | ||
| pip install materials-compendium | ||
| Installation from Repository | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Alternatively, if you prefer to work directly from the repository, | ||
| follow these steps: | ||
|
|
||
| .. code:: sh | ||
| git clone https://github.com/pyne/materials-compendium.git | ||
| cd materials-compendium | ||
| pip install . | ||
| For running tests, use: | ||
|
|
||
| .. code:: sh | ||
| pip install .[test] | ||
| Disclaimer | ||
| ---------- | ||
|
|
||
| - The material composition data enclosed within the JSON file are | ||
| meticulously curated and aligned with Revision 2 of the Compendium. | ||
| These data are thoughtfully annotated with references for user | ||
| assurance. It’s imperative to acknowledge the potential variances in | ||
| composition or densities for certain materials, and we’ve diligently | ||
| included ranges in references whenever feasible. | ||
| - For materials not cataloged in the provided references, users may | ||
| find it necessary to supply application-specific impurity | ||
| information. | ||
| - We stress the importance of meticulously aligning simulation | ||
| parameters, such as reaction cross sections, within your selected | ||
| radiation transport code to uphold the integrity of simulation | ||
| outcomes. | ||
|
|
||
| Noteworthy | ||
| ---------- | ||
|
|
||
| - While this script is meticulously tailored to JSON file parsing for | ||
| radiation transport modeling, its adaptability for other applications | ||
| is an avenue worth exploring. | ||
|
|
||
| Contributions | ||
| ------------- | ||
|
|
||
| We extend a warm invitation to contribute to the **Materials | ||
| Compendium**. We believe that fostering an environment of collaboration | ||
| is paramount. Should you wish to contribute, the process is as | ||
| straightforward as forking our repository on GitHub, implementing your | ||
| modifications, and subsequently initiating a pull request. Should | ||
| queries arise or assistance be required during this process, please | ||
| don’t hesitate to engage with us through the PyNE mailing list | ||
| (https://groups.google.com/forum/#!forum/pyne-dev, | ||
| [email protected]). Your involvement will undoubtedly enrich the | ||
| package and its utility. |