Skip to main content

​
Prerequisites - MongoDB Instance

Navigate to MongoDB Atlas and create a free cluster. This will serve as the launchpad for your workflows. You will need to allow network access from all IP Addresses for our service to submit workflows. Instructions can be found here. When you create the cluster, you will be given a URI connection string. Copy this connection string to be used in the next step.

​
Quickstart

Clone the Molecular Studio V Environment repository to your local machine. This will contain the necessary files to run the Molecular Studio V environment. External programs, such as ORCA, may need to be installed separately.

​
Installation

Windows Users: Please use WSL for running the Molecule Studio V environment
ORCA Users: We do not provide the executables for ORCA. You will need to install ORCA separately. See here for instructions.

​
Pixi

To install pixi you can run the following command in your terminal: 
curl -fsSL https://pixi.sh/install.sh | sh
if your system does not have curl installed, you can install it with wget: 
wget -qO- https://pixi.sh/install.sh | sh

​
Direnv

See direnv for more information on how to install it.

​
Getting Started

Once you have pixi and direnv installed, you can use the following commands to get started: 
pixi run setup
You will be required to enter your MongoDB URI for your Fireworks database. If you are starting from scratch without any workflows in your database, you can run the following command to initialize the database: 
pixi run fireworks_setup
You will need to allow direnv to load the environment via direnv allow .. The environment should now automagically load/unload every time you cd into/out of the directory.

​
Running Workflows

To run a workflow, you can use the following command: 
pixi run launch

​
Manual Installation

Install the JobflowChemistry Python package 
pip install -U git+https://github.com/cfarm6/JobflowChemistry.git
Additionally, install the following dependencies: 
pip install jobflow
pip install fireworks
JobflowChemistry is a Python package that allows you to build and run workflows using the Jobflow framework. Jobflow is a Python package that allows you to build and run workflows using the Fireworks framework for workflow management. Additionally, depending on the nodes used in your workflow, you may need to install additional dependencies. For example, ORCA can be installed by following the instructions here. To view a list of the dependencies for each node, see the documentation here.

​
Setting Up A Fireworks Launchpad

To set up a Fireworks launchpad, follow the instructions here. For simiplicity, the steps will be outlined below:

​
1. Install the Fireworks package

pip install fireworks

​
3. Create a my_launchpad.yaml file

In the root directory of your project, run the following command: 
lpad init
You will enter the URI connection string from the previous step when prompted for the host. You can leave the other fields set as their default values. This will create a my_launchpad.yaml file in the root directory of your project.

​
4. Create a jobflow.yaml file

Create an empty jobflow.yaml file in the root directory of your project. This will be used to configure the JobflowChemistry service. Copy the following contents into the file: 
JOB_STORE:
  docs_store:
    type: MongoURIStore
    uri: <MONGODB_URI>
    database: data
    collection_name: docs_store
  additional_stores:
    files:
      type: GridFSURIStore
      database: data
      collection_name: files
      uri: <MONGODB_URI>
    settings: 
      type: MongoURIStore
      uri: <MONGODB_URI>
      database: data
      collection_name: settings
    properties:
      type: MongoURIStore
      uri: <MONGODB_URI>
      database: data
      collection_name: properties
Replace <MONGODB_URI> with the URI connection string from the previous step.

​
5. [Optional] Create a config.sh file

When using jobflow and fireworks in a cluster, you may need to set some environment variables. You need to set the environment variable JOBFLOW_CONFIG_FILE to the path of the jobflow.yaml file. 
export JOBFLOW_CONFIG_FILE=jobflow.yaml
This will allow you to run jobflow and fireworks without having to specify the configuration file each time.

​
6. Upload your connection files to Molecular Studio V

In your browser, open Molecular Studio V. Navigate to the “Workflow Builder” tab and click the Select a launchpad select menu in the lower left corner and select Add or mopdify launchpads. This will open a dialog box where you can upload your my_launchpad.yaml and jobflow.yaml files. You will need to assign a name to your fireworks/jobflow database for convinience. Workflow Builder

​
7. Start Building!

You are now free to start building your workflows! If you have any issues or questions, please reach out to us at operations@vagusllc.com.