documentation:software:atlas:setup
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
documentation:software:atlas:setup [2016/08/19 14:42] frank_defalco created |
documentation:software:atlas:setup [2017/10/17 16:27] anthonysena |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | The following sections detail the process for setting up Atlas and its dependencies. | + | ~~NOTOC~~ |
| - | ====== OHDSI Web API ====== | + | ===== ATLAS Setup ===== |
| - | 1. [[documentation:software:webapi:setup|Install WebAPI]] and configure the appropriate sources. The following figure provides an example topology to show the different elements involved in the WebAPI architecture and a visual representation of the [[documentation:software:webapi:source_configuration|source configuration]]. | + | The following sections detail the process for setting up Atlas and its dependencies. |
| + | ==== Prerequisites ==== | ||
| - | **Note:** The example above does not represent a physical architecture. The WebAPI configuration allows you to physically and logically segregate these data sources based on the requirements of your environment. | + | === WebAPI === |
| + | The first prerequisite for ATLAS is to [[documentation:software:webapi:webapi_installation_guide|Install the OHDSI WebAPI]] and [[documentation:software:webapi:source_configuration|configure the appropriate sources]]. | ||
| - | ## CDM Statistics (Achilles) | + | === ACHILLES === |
| + | To use the [[documentation:software:atlas:data-sources|Data Sources]] feature within ATLAS you must first [[documentation:software:achilles|setup and execute ACHILLES]] in your environment. Once you have successfully generated summary statistics, you are ready to configure ATLAS to use this information. | ||
| - | 1. This page includes information and resources for setting up Achilles in your environment: [installation and support](http://www.ohdsi.org/web/wiki/doku.php?id=documentation:software:achilles). This is prerequisite before you can use the data sources feature within Atlas. Once you have successfully generated summary statistics and have exported your data to JSON format, you are ready to configure Atlas to use this information. | + | ==== ATLAS Installation ==== |
| - | ## Atlas | + | Begin by downloading the latest release of [[https://github.com/OHDSI/Atlas/releases/latest|ATLAS from GitHub]]. |
| - | 1. Grab the latest release of Atlas from here: https://github.com/OHDSI/Atlas/releases. Download and install this onto a web server such that the application will be reachable via the URL: http://<your_webserver>/Atlas . | + | Install the release onto a web server such that the application will be reachable via a URL such as: |
| - | 2. Under the Atlas root folder, edit the file $/js/config.js to configure the following properties: | + | http://<your_webserver>/atlas |
| - | define([], function () { | + | Under the Atlas root folder, edit the file /js/config.js to configure the following properties: |
| - | var config = {}; | + | |
| - | + | <code javascript> | |
| - | config.services = [{ | + | define([], function () { |
| - | name: '<YOUR ENVIRONMENT NAME>', | + | var config = {}; |
| - | url: 'http://your_webserver/WebAPI/' | + | config.services = [{ |
| - | }]; | + | name: '<YOUR ENVIRONMENT NAME>', |
| - | + | url: 'http://your_webserver/WebAPI/' | |
| - | config.webAPIRoot = config.services[0].url; | + | }]; |
| + | |||
| + | config.webAPIRoot = config.services[0].url; | ||
| | | ||
| - | config.dataSourcesLocation = '/achilles/data/datasources.json'; | + | config.dataSourcesLocation = '/achilles/data/datasources.json'; |
| - | config.dataSourcesRoot = '/achilles/data'; | + | config.dataSourcesRoot = '/achilles/data'; |
| - | return config; | + | return config; |
| - | }); | + | }); |
| + | </code> | ||
| + | |||
| + | config.services: Edit this array to provide a name for your environment and the URL for the WebAPI that was set up in WebAPI section. | ||
| + | |||
| + | config.dataSourcesLocation & config.dataSourcesRoot **//(v1.x of Atlas - these configuration settings are no longer required in v2.0)//**: If you have set up your CDM statistics (Achilles), these properties should be set to the URL where your CDM statistics resides. In the configuration below, we are using a relative path since we assume you have hosted your CDM statistics on the same web server as ATLAS but under a different directory. | ||
| + | |||
| + | You should now be able to navigate to ATLAS from your web browser. | ||
| + | |||
| + | http://<your_webserver>/atlas | ||
| - | - Config.services: Edit this array to provide a name for your environment and the URL for the WebAPI that was set up in WebAPI section. | ||
| - | - Config.dataSourcesLocation & Config.dataSourcsRoot: If you have set up your CDM statistics (Achilles), these properties should be set to the URL where your CDM statistics resides. In the configuration below, we are using a relative path since we assume you have hosted your CDM statistics on the same web server as Atlas but under a different directory. | ||
| - | 3. Navigate to Atlas from your web browser: http://your_webserver/Atlas | + | ==== ATLAS Installation Archive ==== |
| + | [[documentation:software:atlas:archive:atlas_setup_v1_x|ARCHIVE: ATLAS Setup (v2.1 or earlier)]] | ||
documentation/software/atlas/setup.txt · Last modified: 2019/05/30 20:47 by anthonysena
Page Tools
