.. |image| image:: https://github.com/pyne/pyne/blob/develop/img/pyne_icon_small.png :class: centered :width: 42px

|image| PyNE: The Nuclear Engineering Toolkit

The PyNE project aims to provide a common set of tools for nuclear science and engineering needs.

If you are interested in the package itself, or would like to help and contribute, please let us know either on the mailing list (https://groups.google.com/forum/#!forum/pyne-dev, pyne-dev@googlegroups.com) or github_.

Examples, documentation, and more can be found at https://pyne.io, the official PyNE project site.

.. _github: https://github.com/pyne/pyne

============ Installation

---

Dependencies

PyNE has the following dependencies: #. Fortran compiler <https://gcc.gnu.org/wiki/GFortran>_ #. C++ compiler <https://gcc.gnu.org/>_ #. CMake <http://www.cmake.org/>_ (>= 2.8.5) #. NumPy <http://www.numpy.org/>_ (>= 1.8.0) #. SciPy <http://www.scipy.org/>_ #. Cython <http://cython.org/>_ (>= 0.29.21) #. HDF5 <http://www.hdfgroup.org/HDF5/>_ #. PyTables <http://www.pytables.org/>_ #. Python <http://www.python.org/>_ (>= 3.5.2) #. LAPACK <http://www.netlib.org/lapack/>_ #. BLAS <http://www.netlib.org/blas/>_ #. Jinja2 <http://jinja.pocoo.org/>_

Optional Depenendencies: #. MOAB <https://sigma.mcs.anl.gov/moab-library/>_ #. DAGMC <https://svalinn.github.io/DAGMC/install/index.html>__ #. OpenMC <https://docs.openmc.org/en/stable/quickinstall.html>_

To run tutorial and examples: #. jupyter <http://jupyter.org/>_

Additionally, building the documentation requires the following: #. Sphinx <http://sphinx-doc.org/>_ #. sphinxcontrib-bibtex <https://pypi.python.org/pypi/sphinxcontrib-bibtex/>_ #. PrettyTable <https://code.google.com/p/prettytable/>_ #. numpydoc <https://pypi.python.org/pypi/numpydoc>_ #. jupyter <http://jupyter.org/>_

Most of the dependencies are readily available through package managers (such as MacPorts, Anaconda, etc.). Visit our installation page <http://pyne.io/install/index.html>_ for instructions on getting PyNE up and running on your device.

============ Contributing

We highly encourage contributions to PyNE! If you would like to contribute, it is as easy as forking the repository on GitHub, making your changes, and issuing a pull request. If you have any questions or need assistance during this process, don't hesitate to reach out to the PyNE mailing list (https://groups.google.com/forum/#!forum/pyne-dev, pyne-dev@googlegroups.com).