Quick Install Guide
=================================

MCNPy is packaged as a Python wheel and thus is installed like a regular package.

Download
--------
* `MCNPy Github repository <https://github.rpi.edu/NuCoMP/mcnpy>`_

Dependencies
------------
* `Java 8 <https://www.openlogic.com/openjdk-downloads>`_
* `py4J <https://www.py4j.org/>`_
* `h5py <https://www.h5py.org/>`_
* `psutil <https://pypi.org/project/psutil/>`_
* `NumPy <https://numpy.org/>`_
* `MetaPy <https://github.rpi.edu/NuCoMP/metapy>`_
* Everything else should come with a standard Python install

The Python dependencies will be automatically retrieved during installation. 

.. important:: At this time, MetaPy *must* be `manually downloaded <https://github.rpi.edu/NuCoMP/metapy>`_ and then installed from the ``.whl`` file. Running ``pip install metapy`` will retrieve the wrong package.

Install
-------
#. Clone the repository: ``git clone https://github.rpi.edu/NuCoMP/mcnpy.git``.
#. Ensure you are running the desired Python environment.
    * Try ``conda activate ENV_NAME`` to switch.
#. Run ``pip install /path/to/cloned/repo/dist/mcnpy-X.whl`` where ``X`` is the version.
    * All dependencies *except* ``metapy`` will be downloaded if needed.
    * ``metapy`` must be installed from the `MetaPy repository <https://github.rpi.edu/NuCoMP/metapy>`_.
#. Done!

Uninstall
---------
.. code-block:: bash

    pip uninstall mcnpy