goofit 2.2.1

Installation basics

This package can be installed with pip, but uses SciKit-Build, and is build, fully optimized, on your system. Because of this, there are a few caveats when running a pip install. Make sure you have SciKit-Build (pip install scikit-build) before you attempt an install. Also, if you don’t have a recent version of CMake (3.8 or better recommended), also run pip install cmake. When you build, you should also use pip’s -v flag, so that you can see it build (and observe the configuration options). Otherwise, you might wait a very long time without output (especially if CUDA was found).

Installation: pip

Using pip 10+:

pip install -v goofit

Using pip < 10:

pip install scikit-build
pip install -v goofit

If you want to send commands to CMake through PIP, you will need to pass each option through, starting with a -- option. Pip will try to reuse the built version if you do not pass options, but will rebuild if you pass options. For example, if you are on Anaconda and realize that GooFit and Anaconda are using different OpenMP libraries:

pip install -v goofit --install-option="--" --install-option="-DGOOFIT_DEVICE=CPP"

Installation: local

If you want to add PDFs to GooFit, or use GooFit pacakges, you should be working in a local directory using git. In the following example, I’m assuming you’ve set up SSH keys with GitHub; you can use https instead if you perfer by changing the URL to https://github.com/GooFit/GooFit.git:

git clone --recursive git@github.com:GooFit/GooFit.git
cd goofit

pipenv install --dev

pipenv shell

pip install -v .

pip install -v . --install-options="--" --install-options="-DGOOFIT_PACKAGES=OFF"

Building a source package from git

For developers only:

To make a source package, start with a clean (such as new) git GooFit package with all submodules checked out:

git clone --branch=master --recursive --depth=10 git@github.com:GooFit/GooFit.git
cd goofit
python setup.py sdist
python -m twine upload dist/*

To make a binary package, use instead:

python setup.py bdist_wheel -- -DGOOFIT_OPTI="-march=core2"