This script provides the ability to connect directly to CDD Vault, run saved searches against projects of your choice and return the results directly into StarDrop.
Watch the video for a demonstration of how it works.
Version
This script is for the latest version of StarDrop for either Windows or Mac. To find out which version you have installed, start StarDrop and select the Help->About menu
If you are using an older version of StarDrop, please contact us at support@optibrium.com and we will be happy to help install this script on your StarDrop client.
Installing and using the script
Windows with .zip file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.zip
- In your user area, navigate to the StarDrop Python folder in C:\Users\username\AppData\Roaming\StarDrop
- Extract the contents of the zip file into this folder overwriting any existing files
- You should now see the following folders in the StarDrop folder:
py3\CDD Vault
py3\Utils - Start StarDrop
macOS with .zip file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.zip
- Extract the contents of the zip file into this folder overwriting any existing files, you should now see the following folders in the StarDrop folder:
py3\CDD Vault
py3\Utils
- In your user area, navigate to the StarDrop folder: /Users/username/StarDrop
- Move the unzipped folders, sub-folders, and files into the StarDrop folder, overwriting any existing files
- Start StarDrop
Windows with .exe file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.exe
- When the download is complete, double-click the file to run it and follow the instructions (we recommend that you accept the default options provided)
- Start StarDrop
Click on the Custom Scripts->CDD Vault menu and choose Retrieve Data. This will prompt you to enter a CDD key. To generate a key which will authenticate you each time you use this script (and which will be remembered after you have used it the first time), log in to CDD Vault, go to Settings and choose the API keys menu on the left. Here you will see an option to Add an API key (assuming that you do not have one already) which you can give a name. Once created it will be displayed as a long character string which you can copy and paste into the script dialogue. This will then be saved so that you do not need to enter it each time.
You will be prompted to select a search function. If you wish to retrieve response curve data with your search choose either the Download with response curve urls or Download with response curve plots options. If not, select Download data only. Note, if your saved search doesn’t include the ‘Molecule-Batch ID’ keyword you must select Download data only.
If you have access to more than one vault, then you will be shown a list of those available from which to choose. Once you have chosen a vault (or if you only have access to one vault), you can then choose one of your saved searches which will be run. If you have more than one project in your vault then you can choose which of these against which to run the search (you can select more than one project here if you wish). Finally, if you choose either of the response curve options, you will be prompted to select which protocol(s) to access. The search will then be run and the results returned into StarDrop.
Installation files
Windows with .zip file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.zip
- In your user area, navigate to the StarDrop Python folder in C:\Users\username\AppData\Roaming\StarDrop
- Extract the contents of the zip file into this folder overwriting any existing files
- You should now see the following folders in the StarDrop folder:
py3\CDD Vault
py3\Utils - Start StarDrop
macOS with .zip file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.zip
- Extract the contents of the zip file into this folder overwriting any existing files, you should now see the following folders in the StarDrop folder:
py3\CDD Vault
py3\Utils
- In your user area, navigate to the StarDrop folder: /Users/username/StarDrop
- Move the unzipped folders, sub-folders, and files into the StarDrop folder, overwriting any existing files
- Start StarDrop
Windows with .exe file
- Exit StarDrop
- Download StarDrop Script – CDD Vault_py3Qt.exe
- When the download is complete, double-click the file to run it and follow the instructions (we recommend that you accept the default options provided)
- Start StarDrop
How to use the script
Click on the Custom Scripts->CDD Vault menu and choose Retrieve Data. This will prompt you to enter a CDD key. To generate a key which will authenticate you each time you use this script (and which will be remembered after you have used it the first time), log in to CDD Vault, go to Settings and choose the API keys menu on the left. Here you will see an option to Add an API key (assuming that you do not have one already) which you can give a name. Once created it will be displayed as a long character string which you can copy and paste into the script dialogue. This will then be saved so that you do not need to enter it each time.
You will be prompted to select a search function. If you wish to retrieve response curve data with your search choose either the Download with response curve urls or Download with response curve plots options. If not, select Download data only. Note, if your saved search doesn’t include the ‘Molecule-Batch ID’ keyword you must select Download data only.
If you have access to more than one vault, then you will be shown a list of those available from which to choose. Once you have chosen a vault (or if you only have access to one vault), you can then choose one of your saved searches which will be run. If you have more than one project in your vault then you can choose which of these against which to run the search (you can select more than one project here if you wish). Finally, if you choose either of the response curve options, you will be prompted to select which protocol(s) to access. The search will then be run and the results returned into StarDrop.