Currently, we suggest that you install FireWorks in developer mode using the instructions below rather than using pip or easy-install.
To prepare for installation, you should:
Tip
if you have easy_install configured, e.g. through setuptools, you should be able to install pip using the command easy_install pip.
Run the following code to download the FireWorks source:
git clone git@github.com:materialsproject/fireworks.git
Navigate inside the FireWorks directory containing the file setup.py:
cd fireworks
Install the needed dependencies using pip with the following commands (with administrator privileges):
pip install nose
pip install pyyaml
pip install pymongo
Tip
If you have an old version of these libraries installed, you might need to run pip install --upgrade <PACKAGE>. In particular, ensure that pymongo is >= 2.4.2 and includes MongoClient.
Run the following command (you might need administrator privileges, so pre-pend the word ‘sudo’ as needed):
python setup.py develop
Staying in the directory containing setup.py, run the following command:
nosetests
Ideally, a printout should indicate that all tests have passed. If not, you might try to debug based on the error indicated, or you can let us know the problem so we can improve the docs (see Contributing and Contact).
If you want to update an existing FireWorks installation, use the following steps:
Navigate inside your FireWorks source directory containing the file setup.py
Run the following commands:
git pull
python setup.py develop
nosetests