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 http://pyne.io/, the official PyNE projectsite.

PyNE has the following dependencies:

1. CMake (>= 2.8.5)
2. NumPy (>= 1.8.0)
3. SciPy
4. Cython (>= 0.19.1)
5. HDF5
6. PyTables
7. Python 2.7

Additionally, building the documentation requires the following:

1. Sphinx
2. SciSphinx
3. breathe

A binary distribution of PyNE is hopefully coming soon. Until then, please install from source.

Installing PyNE from source is a two-step process. First, download and unzip the source (zip, tar). Then run the following commands from the unzipped directory:

cd pyne/
python setup.py install --user
scripts/nuc_data_make

The setup.py command compiles and installs the PyNE source code. The nuc_data_make builds and installs a database of nuclear data. Unfortunately, this must be done as a second step because most nuclear data is under some form of license restriction or export control which prevents the developers from distributing it with PyNE. However, the nuc_data_make program (which is installed by setup.py) will do its best to find relevant nuclear data elsewhere on your machine or from public sources on the internet.

The instructions are based on using the homebrew http://brew.sh/ package manager Install command line tools from https://developer.apple.com/downloads/ you will need to create an account in order to download:

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go/install)"
brew doctor
brew tap homebrew/science
brew install hdf5
brew install cmake
brew install python

Add:

export PATH=/usr/local/bin:$PATH
export PATH=/usr/local/share/python:$PATH

to ~/.bash_profile, then:

source ~/.bash_profile
sudo pip install numpy
sudo chown -R $(whoami) /usr/local
brew install gfortran
pip install scipy
pip install cython
pip install numexpr
pip install tables

download pyne-staging cd to that directory:

cd Downloads/pyne-staging
python setup.py install

It may be necessary to add the pyne library path to the DYLD_FALLBACK_LIBRARY_PATH environment variable before running nuc_data_make. To do this, add the following lines to your ~/.bashrc file where /path/to/pyne/lib is the absolute path to the directory containing libpyne.dylib:

DYLD_FALLBACK_LIBRARY_PATH="${DYLD_FALLBACK_LIBRARY_PATH}:/path/to/pyne/lib"
export DYLD_FALLBACK_LIBRARY_PATH

Once those lines have been added, run the following command before running nuc_data_make:

source ~/.bashrc

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, pyne-dev@googlegroups.com).