Getting started with ChemBDDB

The chembddb module is executed from the following command line:

chembddbshell

This command will work on mac os and ubuntu. For windows users WSL is required.

With ChemBDDB, 4 tasks can be performed:

  • setup: sets up a mysql database with the chembddb schema

  • insert: inserts data from csv files into the database

  • search: searches for molecules within the database using different search criteria

  • delete: deletes specific data from the database or deletes the entire database as per required

Before these four tasks, chembddb requires the user to connect to their mysql server using the host, username and password that was decided during mysql installation.

connect2 page

Setup

  • enter the name of the database that needs to be set up

setup page
  • the database will be created with the following schema

schema
  • tables in the database:

    • Property: consists properties and relevant units

    property table
    • Model: consists of all methods that were used to calculate properties, along with details/options

    model table
    • Molecule: consists of details for each molecule in the database, for example, SMILES, InChI, molecular weights, and other relevant identifiers

    molecule table
    • Functional: if a quantum chemical method was used to calculate the property, this table stores the name of the functional that was used

    functional table
    • Basis_set: if a quantum chemical method was used to calculate the property, this table stores the name of the basis set that was used

    basis_set table
    • Forcefield: if a molecular modeling approach was used to calculate the property, this table stores the name of the forcefield that was used

    forcefield table
    • Value: this table stores the values corresponding to each molecule computed with a specific method; this table is the main/central table in the schema and it has a many-to-many relationship with all other tables

    value table

Insert

  • on the insert page the user is first required to select a database from a list of all databases created using the ChemBDDB schema

  • in order to insert data into the database, 2 types of csv files are required:

    • a meta-data file: this file consists of all the meta-data (i.e., the properties, along with their units and the methods used to calculate them)

    config file
    • a data file: this file consists of the actual data that the user needs to enter into the database

    data file

these files can be uploaded directly on the browser

  • the name of the SMILES column, and the names of any other columns refering to an identifier for molecules in the data file needs to be provided in the fields provided on the insert page

insert page

Delete

  • the user can also delete entries from a database, or delete the entire database

  • the user has to first select the database that they want to delete/delete from

  • the user then has a choice to delete by molecule, or delete by property

  • if all fields are left blank when the delete button is clicked, the database will be deleted

delete page