Basic FireWorks installation

Currently, we suggest that you install FireWorks in developer mode using the instructions below rather than using pip or easy-install.

Preparing to Install

To prepare for installation, you should:

  1. Install python 2.7 (preferably Python 2.7.3), if not already packaged with your system. To check your python version, use the command python --version.
  2. Install pip, if not already packaged with your system. This will allow you to download required dependencies.

Tip

if you have easy_install configured, e.g. through setuptools, you should be able to install pip using the command easy_install pip. You should make sure that setuptools is installed using the proper Python version and probably without the --user option if running ez_setup.py.

Virtualenv installation option

Virtualenv is a tool that allows you to separate your FireWorks installation from your other Python installations. For example, you might want to use Python 2.7 for FireWorks, but Python 3+ for other Python codes you’re interested in using. Or, you might have different versions of Python libraries supporting FireWorks and your other installations. This is often the case on shared machinesp. if you’re interested in this option, you might consider a virtualenv install. Otherwise, just follow the installation instructions below.

Installation Method 1: Use Pip

The easiest way to install FireWorks is to simply run a one-liner in pip. The downside of this method is that it is more difficult to view and edit the source code.

  1. To install, simply type:

    pip install FireWorks

    Note

    You may need administrator access, e.g. sudo pip install FireWorks.

  2. Separately, you can download the FireWork tutorial files if you plan on going through the tutorials. You can download these from the FireWorks Github page. All you need is the fw_tutorial directory, but it might be easiest to download the entire source and just copy the fw_tutorial directory somewhere else.

Installation Method 2: Use Git to install in developer mode

The most comprehensive way to install FireWorks is in ‘developer mode’, which will allow you to easily view and modify the source code and fork the repo for development purposes. However, this method requires setting up an account on GitHub and properly setting up SSH keys.

  1. Install git, if not already packaged with your system. This will allow you to download the latest source code.

  2. Run the following code to download the FireWorks source:

    git clone git@github.com:materialsproject/fireworks.git

    Note

    Make sure you have an account on GitHub set up, and have associated your SSH key on your computer with your GitHub account. Otherwise you might get a cryptic Permission denied (publickey) error. Help on ssh keys can be found here.

  3. Navigate inside the FireWorks directory containing the file setup.py:

    cd fireworks
  4. Install the needed dependencies using pip with the following commands (with administrator privileges):

    pip install nose
    pip install pyyaml
    pip install pymongo
    pip install django

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, and Django is greater than v1.5.

Note

Django is only needed if you plan to use the web frontend.

  1. Run the following command (you might need administrator privileges, so pre-pend the word ‘sudo’ as needed):

    python setup.py develop

Run unit tests

  1. Staying in the directory containing setup.py, run the following command:

    nosetests
    
  2. 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 / Contact / Bug Reports).

Updating an existing FireWorks installation

If you want to update an existing FireWorks installation and used the simple pip install (Method 1), just run:

pip install --upgrade FireWorks

If you installed FireWorks in developer mode:

  1. Navigate inside your FireWorks source directory containing the file setup.py (you can type lpad version to tell you where this is).

  2. Run the following commands:

    git pull
    
    python setup.py develop
    
    nosetests