ohdsi / ohdsi-in-a-box Goto Github PK

Quickly deploy a single instance implementation of OHDSI tools and sample data for personal learning and training enviroments. If you are looking to deploy a enterprise, scalable OHDSI architecture then check out the OHDSIonAWS project. A Linux and Windows version of this environment are offered. Both versions have the same set of OHDSI tools. The Windows version uses 'pgAdmin 4' to allow access to the Postgres database while the Linux version uses 'SQL Workbench'. The Linux version is ~40% less expensive to run, depending on the exact AWS instance type you choose. You can also easily add multiple users to a single instance of the Linux version if you like.

AWS Region Code	Name	Launch
cn-northwest-1	China (Ningxia)
eu-west-1	EU (Ireland)
ap-northeast-1	AP (Tokyo)
us-east-1	US East (N. Virginia)

RDP username: ohdsi
RDP password: this is specified as a parameter during deployment
Postgres username: ohdsi
Postgres password: this is specified as a parameter during deployment

If you want to add users to the OHDSI-in-a-Box Linux version, you can do this by using the adduser command and then copying the ohdsi user home directory, as shown in the screenshot below:

AWS Region Code	Name	Launch
cn-northwest-1	China (Ningxia)
ap-northeast-1	AP (Tokyo)
eu-west-1	EU (Ireland)
us-east-1	US East (N. Virginia)

RDP username: ohdsi
RDP password: this is specified as a parameter during deployment
Postgres username: postgres
Postgres password: ohdsi

OHDSI-in-a-Box is specifically created as a learning environment, and is used in most of the tutorials provided by the OHDSI community. It includes many OHDSI tools, sample data sets, RStudio and other supporting software in a single, low cost Windows virtual machine. A PostgreSQL database is used to store the CDM and also to store the intermediary results from ATLAS. The OMOP CDM data mapping and ETL tools are also included in OHDSI-in-a-Box. A high-level diagram showing how the different components of OHDSI map to AWS Services is shown below.

0. Install an RDP client to access you OHDSI-in-a-Box instance
   Windows includes an RDP client by default. To verify, in the search box on the taskbar, type Remote Desktop Connection, and then select Remote Desktop Connection. If your computer doesn't show this application, see the Windows home page and search for the download for the Microsoft Remote Desktop app.
   Mac OS X Download the Microsoft Remote Desktop app from the Mac App Store.
   Linux Use rdesktop.

1. Begin the deployment process by clicking the Launch Stack button at the top of this page the corresponds to the version (Windows or Linux) and the AWS Region you want to us. This will take you to the CloudFormation Manage Console. You will see the CloudFormation template URL is pre-populated. Click Next.

2. The next screen will take in all of the parameters for your OHDSI environment. A description is provided for each parameter to help explain its function, but following is also a detailed description of how to use each parameter. At the top of this screen, be sure to provide a unique Stack Name.

When you've provided appropriate values for the Parameters, choose Next.

3. On the next screen, you can provide some other optional information like tags at your discretion, or just choose Next.

4. On the next screen, you can review what will be deployed. Be sure to check the box that says I acknowledge that AWS CloudFormation might create IAM resources. as shown in the image below. Then choose Create.

5. You can watch as CloudFormation builds out your OHDSI environment. A CloudFormation deployment is called a stack. The parent stack creates several child stacks depending on the parameters you provided. When all the stacks have reached the green CREATE_COMPLETE status, as shown in the screenshot following, then the OHDSI architecture has been deployed. Select the Outputs tab to find a link to your OHDSI-in-a-Box instances, as shown below.

6. You will now see a list of all of your OHDSI-in-a-Box instances and you can connect to them using your Remote Desktop client, the username ohdsi and the password you provided as a parameter. It will take about 5 minutes after this list appears for each OHDSI-in-a-Box instance to boot up and for the password to be set. If you connect to your instance and it says the password is incorrect, just wait a few more minutes for the password automation to complete.

7. Once you are finished with your OHDSI-in-a-Box instances, just return to the AWS CloudFormation console and Delete the stack, as shown below. This will terminate all of the instances you launched.

If you prefer to create your own customer OHDSI-in-a-Box image, take a look at the steps used to build this one. They are documented in a file called OHDSI-In-a-box-QuickStart-Installation-Guide-v1.02 in this repository.

If you'd like to add another user to your OHDSI-in-a-Box Linux instance, just login as the default 'ohdsi' user, open the Terminal icon on the desktop, and run the below commands replacing 'user2' with the username you'd like to use. You can use this command over and over again to add new users.

sudo adduser user2
sudo cp -a . ../user2
sudo chown -R user2:user2 ../user2/.

This library is licensed under the Apache 2.0 License.