Skip to content
Perform GCMC sampling using Fireworks!
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Build Status codecov DOI

GCMCworkflow is a Python package for performing GCMC sampling of gas adsorption using Fireworks.


GCMCWorkflow can be installed via the following steps:

git clone

cd hydraspa

pip install -r requirements.txt .

cd ../

git clone

cd GCMCWorkflow

pip install -r requirements.txt

# for some pymongo connections
pip install dnspython

# for Raspa simulations
pip install raspa2

Usage and basic tutorial

GCMCWorkflow relies on Fireworks for managing the Workflow execution. You should first familiarise yourself with this package, especially how to use a MongoDB server

A short example for how to set up a simulation of the GCMC sampling of Argon adsorption in IRMOF-1 using Raspa is given:

We will first use hydraspa to prepare the simulation inputs:

hydraspa create -s IRMOF-1 -g Ar -f UFF -o IRMOF1_Argon

This creates a directory called IRMOF1_Argon containing a Raspa input template for our future simulations.

In order to define a sampling Workflow, a "spec file" must be given, an example workflow spec file is given below. This contains information on the temperatures (78K) and pressures (100 to 201,000 Pa) we wish to sample, as well as providing the paths of the templates to be used.

# Example workflow_spec.yml file
name: ArIrmof1
 - logspace(100, 125000.0, 10)
 - 0.15M
 - 0.201M  # saturation pressure
 - 78.0
template: IRMOF1_Argon/template/
workdir: IRMOF1_Argon/
nparallel: 1
ncycles: 5000

We can then add this Workflow to our LaunchPad via the submit command:

gcmcworkflow submit workflow_spec.yml -l my_launchpad.yaml

Once submitted, we can check what GCMC Workflows have been submitted using the list command, and query individual Workflows with the check command:

gcmcworkflow -l my_launchpad.yaml list
gcmcworkflow -l my_launchpad.yaml check ArIrmof1

The Workflow is executed as normal using Fireworks, using the rlaunch command. For example to execute the Workflow using 4 parallel cores:

rlaunch multi 4

This will run Fireworks (compute tasks) from the Workflow until completion. The progress of these can be viewed by looking inside the IRMOF1_Argon directory.

Upon completion, a file called "results.csv" will be created in the working directory containing the results of our sampling.


If you find this software useful for your research, consider citing the following publications:

Jain, A., Ong, S. P., Chen, W., Medasani, B., Qu, X., Kocher, M., Brafman, M., Petretto, G., Rignanese, G.-M., Hautier, G., Gunter, D., and Persson, K. A. (2015) FireWorks: a dynamic workflow system designed for high-throughput applications. Concurrency Computat.: Pract. Exper., 27: 5037–5059. doi: 10.1002/cpe.3505.


GCMCWorkflow is being actively developed, drop me a line!

You can’t perform that action at this time.