Skip to main content

How to install myChEMBL using two Vagrant commands

 

 

 

TL;DR

  1. install Vagrant and VirtualBox
  2. run vagrant init chembl/myChEMBL && vagrant up
  3. wait a bit...
  4. go to http://127.0.0.1:8000/
  5. enjoy!

What have I just done?


Vagrant is a tool for building and deploying complete development environments and myChEMBL 18 now supports installation via Vagrant. We achieved this by first creating a myChEMBL Vagrant Box, which we then register on the Vagrant Cloud. This then allows users to install myChEMBL on there local system using two simple commands*:

vagrant init chembl/myChEMBL
vagrant up


*assumes you have vagrant installed

It's that simple! After you type this into your system console, the expected output should be similar to the one below:




What are those two commands doing?


The first command initializes the current directory to be a Vagrant environment by creating an initial Vagrantfile and prepopulates the config.vm.box setting in the created Vagrantfile. This happens immediately. This command should be executed only once.

The second one, when executed for the first time, downloads myChEMBL box file from the public repository, unpacks it and store downloaded files into a dedicated directory on your machine, so you won't have to download it again. Then, it configures myChEMBL virtual machines and runs it using VirtualBox. The box file is big (7GB) so it will take some time to download and uncompress, but this will happen only once.

OK, so I've executed them successfully, now what?


Just open your favorite browser and type this URL: http://127.0.0.1:8000/. You should see the my ChEMBL LaunchPad (We have seen apache take a little while to fire up, so if you do not see LaunchPad straight away give a couple more minutes).

Can I ssh into the machine?

 

Yes, just type:

vagrant ssh

and you are there. You are logged in as a special 'vagrant' user with root privileges and no password. If you prefer to work as a standard 'chembl' user just type:

sudo su - chembl

Great, now how can I switch the machine off?


Do it by typing:

vagrant halt

You can bring it up anytime using already known command:

vagrant up

which should execute very fast for the second time as everything is already downloaded.

Are there any software dependencies?


Yes, but not many. In order to use Vagrant you should install it. Our configuration currently supports only VirtualBox as a provider so you should install it as well.

What advantages does the myChEMBL Vagrant install offer over the standard myChEMBL installation?

  1. First of all, you don't have to remember the download URL of where the myChEMBL Vagrant box lives. All you need to know is a box name: 'chembl/myChEMBL'.   
  2. You don't have to think about any configuring VirtualBox image (e.g. network settings), as all of the configuration is stored in a Vagranfile prepared by us.
  3. Using command line interface it is easy to deploy myChEMBL on multiple machines automatically. You can run it easily on your headless server.
  4. The download is smaller, so it will download faster. The box file size is 7.1GB compared to 8.5 GB of standard myChEMBL-18_0-disk1.vmdk file.
If future, we plan to support more providers, in particular Amazon Web Services and Docker.
We also plan to make provisioning more flexible so if needed you will be able to choose what Linux distribution should be used as a base for your myChEMBL (Red Hat and CentOS are the most important distros we would like to support).

Bugs and help


We've found a couple of minor bugs since the release of myChEMBL 18. They are all fixed now and mychembl vagrant box includes all the fixes. If you happen to find any other issue, related to myChEMBL or specific to our vagrant distribution, please report it to mychembl[at]ebi.ac.uk.

You can always check for new updates using following command:

vagrant box outdated

In case new updated are available you can update the box by running:

vagrant box update

Just please remember that updating the box means downloading it from remote repository so it will take some time. Also note that this command will not magically update running Vagrant environments. If a Vagrant environment is already running, you'll have to destroy and recreate it to acquire the new updates in the box.

In our next myChEMBL related blog post we will tell you how to install myChEMBL on local VM or 'metal' machine running Ubuntu (Hint: have a look at this file).

Comments

Popular posts from this blog

Improvements in SureChEMBL's chemistry search and adoption of RDKit

    Dear SureChEMBL users, If you frequently rely on our "chemistry search" feature, today brings great news! We’ve recently implemented a major update that makes your search experience faster than ever. What's New? Last week, we upgraded our structure search engine by aligning it with the core code base used in ChEMBL . This update allows SureChEMBL to leverage our FPSim2 Python package , returning results in approximately one second. The similarity search relies on 256-bit RDKit -calculated ECFP4 fingerprints, and a single instance requires approximately 1 GB of RAM to run. SureChEMBL’s FPSim2 file is not currently available for download, but we are considering generating it periodicaly and have created it once for you to try in Google Colab ! For substructure searches, we now also use an RDKit -based solution via SubstructLibrary , which returns results several times faster than our previous implementation. Additionally, structure search results are now sorted by...

Improved querying for SureChEMBL

    Dear SureChEMBL users, Earlier this year we ran a survey to identify what you, the users, would like to see next in SureChEMBL. Thank you for offering your feedback! This gave us the opportunity to have some interesting discussions both internally and externally. While we can't publicly reveal precisely our plans for the coming months (everything will be delivered at the right time), we can at least say that improving the compound structure extraction quality is a priority. Unfortunately, the change won't happen overnight as reprocessing 167 millions patents takes a while. However, the good news is that the new generation of optical chemical structure recognition shows good performance, even for patent images! We hope we can share our results with you soon. So in the meantime, what are we doing? You may have noticed a few changes on the SureChEMBL main page. No more "Beta" flag since we consider the system to be stable enough (it does not mean that you will never ...

ChEMBL 34 is out!

We are delighted to announce the release of ChEMBL 34, which includes a full update to drug and clinical candidate drug data. This version of the database, prepared on 28/03/2024 contains:         2,431,025 compounds (of which 2,409,270 have mol files)         3,106,257 compound records (non-unique compounds)         20,772,701 activities         1,644,390 assays         15,598 targets         89,892 documents Data can be downloaded from the ChEMBL FTP site:  https://ftp.ebi.ac.uk/pub/databases/chembl/ChEMBLdb/releases/chembl_34/ Please see ChEMBL_34 release notes for full details of all changes in this release:  https://ftp.ebi.ac.uk/pub/databases/chembl/ChEMBLdb/releases/chembl_34/chembl_34_release_notes.txt New Data Sources European Medicines Agency (src_id = 66): European Medicines Agency's data correspond to EMA drugs prior to 20 January 2023 (excluding ...

ChEMBL brings drug bioactivity data to the Protein Data Bank in Europe

In the quest to develop new drugs, understanding the 3D structure of molecules is crucial. Resources like the Protein Data Bank in Europe (PDBe) and the Cambridge Structural Database (CSD) provide these 3D blueprints for many biological molecules. However, researchers also need to know how these molecules interact with their biological target – their bioactivity. ChEMBL is a treasure trove of bioactivity data for countless drug-like molecules. It tells us how strongly a molecule binds to a target, how it affects a biological process, and even how it might be metabolized. But here's the catch: while ChEMBL provides extensive information on a molecule's activity and cross references to other data sources, it doesn't always tell us if a 3D structure is available for a specific drug-target complex. This can be a roadblock for researchers who need that structural information to design effective drugs. Therefore, connecting ChEMBL data with resources like PDBe and CSD is essen...

In search of the perfect assay description

Credit: Science biotech, CC BY-SA 4.0 Assays des cribe the experimental set-up when testing the activity of drug-like compounds against biological targets; they provide useful context for researchers interested in drug-target relationships. Ver sion 33 of ChEMBL contains 1.6 million diverse assays spanning ADMET, physicochemical, binding, functional and toxicity experiments. A set of well-defined and structured assay descriptions would be valuable for the drug discovery community, particularly for text mining and NLP projects. These would also support ChEMBL's ongoing efforts towards an  in vitro  assay classification. This Blog post will consider the features of the 'perfect' assay description and provide a guide for depositors on the submission of high quality data. ChEMBL's assays are typically structured with the overall aim, target, and method .  The ideal assay description is succinct but contains all the necessary information for easy interpretation by database u...