Differences

This shows you the differences between two versions of the page.

--- documentation:software:atlas:setup [2016/08/19 14:42]
frank_defalco created
+++ documentation:software:atlas:setup [2019/05/30 20:47] (current)
anthonysena
@@ Line 1: / Line 1: @@
+~~NOTOC~~
+===== IMPORTANT NOTE =====
+All ATLAS documentation has moved to [[https://github.com/OHDSI/ATLAS/wiki|GitHub]]. Please disregard the content below as it is legacy and kept for posterity.
+===== ATLAS Setup (LEGACY) =====
 The following sections detail the process for setting up Atlas and its dependencies.
-====== OHDSI Web API ======
+==== Prerequisites ====
+=== 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]].
+=== 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.
+**Please note**: If you utilized Achilles prior to v1.4, please refer to the article [[documentation:software:atlas:achilles_v_1_5|Achilles v1.5.0 Dependencies For WebAPI/Atlas]] as Atlas/WebAPI v2.2.0 will require some additions to the Achilles output.
+==== ATLAS Installation (V2.2.0 and later) ====
+Begin by downloading the latest release of [[https://github.com/OHDSI/Atlas/releases/latest|ATLAS from GitHub]].
-. [[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]].
+Install the release onto a web server such that the application will be reachable via a URL such as:
+  http://<your_webserver>/atlas
-**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.
+Under the Atlas root folder, create the file /js/config-local.js to configure the application. **Please note: the file /js/config-local.js is __not__ included in the Atlas repository. This is by design so that you may have environment-specific configuration. ** Config-local.js will override the settings found in /js/config.js as shown here:
-## CDM Statistics (Achilles)
+<code javascript>
+define([], function () {
+	var configLocal = {};
-. 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.
+	configLocal.api = {
+		name: 'My Organization Name',
+		url: 'https://webapi.server.com/WebAPI/'
+	};
-## Atlas
+	return configLocal;
+});
+</code>
-. 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 .
+In the example above, the /js/config-local.js overrides the corresponding ".api" property found in /js/config.js and allows for custom configuration for your environment. The same pattern can be used to override the other settings in /js/config.js.
-. Under the Atlas root folder, edit the file $/js/config.js to configure the following properties:
+Once this is complete, you should now be able to navigate to ATLAS from your web browser.
-            define([], function () {
+  http://<your_webserver>/atlas
-                var config = {};
-                config.services = [{
-                    name: '<YOUR ENVIRONMENT NAME>',
-                    url: 'http://your_webserver/WebAPI/'
-                }];
-                config.webAPIRoot = config.services[0].url;
-                config.dataSourcesLocation = '/achilles/data/datasources.json';
-                config.dataSourcesRoot = '/achilles/data';
-                return config;
-              });
-    - 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.
-. 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)]]

Observational Health Data Sciences and Informatics

User Tools

Site Tools

Differences

Page Tools