Skip to content

Latest commit

 

History

History
68 lines (56 loc) · 2.47 KB

readme.rst

File metadata and controls

68 lines (56 loc) · 2.47 KB
Raw

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, [email protected]) or github.

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

Installation

Dependencies

PyNE has the following dependencies:
  1. Fortran compiler
  2. C++ compiler
  3. CMake (>= 2.8.5)
  4. NumPy (>= 1.8.0)
  5. SciPy
  6. Cython (>= 0.19.1)
  7. HDF5
  8. PyTables
  9. Python (>= 3.5.2)
  10. LAPACK
  11. BLAS
  12. Jinja2
Optional Depenendencies:
  1. MOAB
  2. DAGMC
  3. OpenMC
To run tutorial and examples:
  1. jupyter
Additionally, building the documentation requires the following:
  1. Sphinx
  2. sphinxcontrib-bibtex
  3. PrettyTable
  4. numpydoc
  5. jupyter

Most of the dependencies are readily available through package managers (such as MacPorts, Anaconda, etc.). Visit our installation page 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 about this process don't hesitate to ask the mailing list (https://groups.google.com/forum/#!forum/pyne-dev, [email protected]).