-
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
32c00b4
commit 7da53a7
Showing
1 changed file
with
111 additions
and
14 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -1,20 +1,117 @@ | ||
| .. Materials Compendium documentation master file, created by | ||
| sphinx-quickstart on Mon Aug 14 19:34:26 2023. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| ====================================== | ||
| Materials Compendium | ||
| ====================================== | ||
|
|
||
| Welcome to Materials Compendium's documentation! | ||
| ================================================ | ||
| 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. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Contents: | ||
| .. 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="tutorial/index.html">Tutorial</a></li> | ||
| <li><a href="examples/index.html">Examples</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <br /> | ||
| <div id="pynemenuheader"> | ||
| <a id="usingHeader" | ||
| href="javascript:pyneToggle('Using PyNE', 'usingContent', 'usingHeader');"> | ||
| Using PyNE [+]</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="pyapi/index.html">Python 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/pyne/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="devsguide/index.html">Developer's Guide</a></li> | ||
| <li><a href="http://github.com/pyne/pyne">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="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="theorymanual/index.html">Theory Manual</a></li> | ||
| <li><a href="pubs.html">Publications</a></li> | ||
| <li><a href="previous/index.html">Release Notes</a></li> | ||
| <li><a href="gsoc/index.html">Project Ideas</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| api/index | ||
| .. | ||
| .. gallery/index | ||
| .. previous/index | ||
| .. dev_team | ||
| .. pubs | ||
| .. gsoc/index | ||
| .. | ||
| .. _C++ API: cppapi/html/index.html | ||
|
|
||
| .. _GitHub project site: https://github.com/pyne | ||
|
|
||
| Indices and tables | ||
| ================== | ||
| .. _github: https://github.com/pyne/materials-compendium | ||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` |