.. MontePy documentation master file, created by
   sphinx-quickstart on Thu Apr 21 15:29:53 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MontePy: a Python library for MCNP input files.
===============================================

MontePy is a Python library for reading, editing, and writing MCNP input files.
MontePy provides an object-oriented interface for MCNP input files. 
This allows for easy automation of many different tasks for working with MCNP input files.

Installing
----------

MontePy can be installed with pip:

.. code-block:: shell

   pip install montepy


.. toctree::
   :maxdepth: 2
   :caption: Table of Contents:

   users
   dev_tree
   api/modules

See Also
========

* `MontePy github Repository <https://github.com/idaholab/montepy>`_
* `MontePy PyPI Project <https://pypi.org/project/montepy/>`_
* `MCNP 6.3 User Manual <https://www.osti.gov/biblio/1889957>`_ DOI: `10.2172/1889957 <https://doi.org/10.2172/1889957>`_
* `MCNP 6.2 User Manual <https://mcnp.lanl.gov/pdf_files/TechReport_2017_LANL_LA-UR-17-29981_WernerArmstrongEtAl.pdf>`_
* `MCNP Forum <https://mcnp.discourse.group/>`_

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`