Differences

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

--- getting_started_with_capri [2021/05/24 10:10] – [3. Extract the files to a local hard drive] Adding images showing installation directory structure torbjornj
+++ getting_started_with_capri [2021/05/24 10:35] – Replacing backslash with slash. torbjornj
@@ Line 1: / Line 1: @@
 ======Getting started with CAPRI======
-===== Download the current release =====
-From 2016, the CAPRI model was made more accessible to the scientific community by the provision of supported stable releases. The stable releases are tagged and “frozen” versions of the model that can be referenced to and that will not change. The bug fixes and other code updates result in new releases with updated revision numbers. The release versions have been subjected to extensive testing, ensuring that all supported features technically work under different hardware/software settings.
-The stable release consists of (a) the model code including raw data and (b) the compiled data base including calibrated baselines. The model is really self contained in (a), since all software and raw data needed to compile the data bases and construct the baselines is found there. Albeit (b), the databases, can be derived from (a), doing so is a somewhat complicated process. Therefore, we provide (b) as a shortcut. Furthermore, it turns out that generating (b) may generate slightly different results on different hardware/software combinations, and therefore it is convenient to use a common versioned database release.
-The current release and selected previous releases can be downloaded as compressed (zipped) archives using the links in the following table. Note that the item "SVN-tag" only are available to developers with a an account in the SVN database. Information about each release is found in the release notes, [[Getting started with CAPRI#Release notes (cumulative)]] and in each release code base.
-^ Release   ^  Item        ^   Link                                                           ^
-| STAR 2.7  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MhJlpsZVKK4eRDCjM2w?e=gLdPBw]]  |
-| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MhJlqh8nnJYSkfOm7hw?e=5dbyr1]]  |
-| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.7]]         |
-| STAR 2.6  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg-080EMGjf1A8H-wuQ?e=9QnIDU]]  |
-| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg-076HkDqqg6mVO0HQ?e=eD0TmO]]  |
-| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.6]]         |
-| STAR 2.5  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg4BDjQ4AbWbXXzY1_g?e=NvyyLT]]  |
-| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg4BBF3d-lsULH9gH3A?e=fIIFOd]]  |
-| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.5]]         |
-| STAR 2.4  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgtQmzmdEn_3FuNaqyA]]           |
-| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgtQlHdUSz6F5Uv_Sgw]]           |
-| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.4]]         |
-| STAR 1.4  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgpgRyPwElFGkhK5QJw]]           |
-| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgpgSo2ebWO0Y-c3oXA]]           |
-| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/1.4]]         |
-===== System requirements =====
-CAPRI requires that you have a windows computer with Java and GAMS ([[http://www.gams.com]], distribution 28.2 or later is recommended) installed. You need a license for the CONOPT solver. Many tasks in CAPRI utilize parallel computing. It is therefore an advantage if you have a machine that can run many threads in parallel.
-Regarding Java: There are some licensing implications when using Oracle's platform. Public updates released after January 2019 will not be available for business, commercial, or production use without a commercial license. Since then the GUI for java can also be executed using a open and free installation of [[https://jdk.java.net/15/|OpenJDK]].
 ===== Installing CAPRI Stable Release 2 and earlier =====
-STAR 2 and earlier releases are published with a full set of data, i.e. including all the intermediate data required to build the complete database and produce a calibrated baseline. The model with raw data and the consolidated model database are shipped in two compressed archives. For STAR 2.7, they are called "STAR_2.7.zip" and "results_2.7.zip" respectively, and with similar naming pattern for other releases. Follow the steps below in order to install CAPRI on your system. Using CAPRI requires extensive knowledge of how the system works. Please look out for CAPRI training courses on the page of upcoming events. The following bare-bone instructions may nevertheless be sufficient to get the system up and technically running.
+CAPRI Stable Release (STAR) 2 and earlier releases are published with a full set of data, i.e. including all the intermediate data required to build the complete database and produce a calibrated baseline. The model with raw data and the consolidated model database are shipped in two compressed archives. For the latest release, STAR 2.7, they are called "STAR_2.7.zip" and "results_2.7.zip" respectively, and with similar naming pattern for other releases. Follow the steps below in order to install CAPRI on your system. Using CAPRI requires extensive knowledge of how the system works. Please look out for CAPRI training courses on the page of upcoming events. The following bare-bone instructions may nevertheless be sufficient to get the system up and technically running.
 ==== 1. Ensure that you have Java and GAMS installed on your computer ====
-See [[system_requirements|System requirements]].
+See [[getting_started_with_capri#system_requirements|system requirements]].
 ==== 2. Download the two archives ====
-Click the links to "Code" and "Database" in the table of available CAPRI versions. We recommend using the latest available release.
+Click the links to "Code" and "Database" in the table of available CAPRI versions [[getting_started_with_capri#Download_the_current_release|below]]. We recommend using the latest available release.
 ==== 3. Extract the files to a local hard drive ====
-  - Create an installation folder to hold **model source files** on your local hard drive such that the path does not contain spaces. Thus, it will not work to install the model in “My Documents” (path containing space) or on a network drive (the access will be too slow). We call this the "CAPRI system folder". We assume here you created a folder ''C:\CAPRI\STAR_2.7''.
+  - Create an installation folder to hold **model source files** on your local hard drive such that the path does not contain spaces. Thus, it will not work to install the model in “My Documents” (path containing space) or on a network drive (the access will be too slow). We call this the "CAPRI system folder". We assume here you created a folder ''C:/CAPRI/STAR_2.7''.
   - Extract the files of the compressed archive with code, e.g. ''STAR_2.7.zip'' into the CAPRI system folder.
-  - Extract the files of the compressed archive with data, e.g. ''results_2.7.zip'' into the subfolder ''output\results'' in the CAPRI system folder.
+  - Extract the files of the compressed archive with data, e.g. ''results_2.7.zip'' into the subfolder ''output/results'' in the CAPRI system folder.
 The resulting directory structure in your CAPRI system folder should look like this afterwards:
@@ Line 56: / Line 23: @@
 {{:wiki:installation_folders_tier1.png?nolink&400|}}
-The directory structure inside the folder ''output\results'' should look like this:
+The directory structure inside the folder ''output/results'' should look like this:
 {{::installation_result_files_and_folders.png?400|List of result folders and files extracted and placed in ./output/results}}
@@ Line 72: / Line 39: @@
   - Click “Save in caprinew.ini” and accept the file name suggested for your settings.
   - Close the GUI, then start it again (using start_capri.bat), to make it process all your settings.
+===== Download the current release =====
+From 2016, the CAPRI model was made more accessible to the scientific community by the provision of supported stable releases. The stable releases are tagged and “frozen” versions of the model that can be referenced to and that will not change. The bug fixes and other code updates result in new releases with updated revision numbers. The release versions have been subjected to extensive testing, ensuring that all supported features technically work under different hardware/software settings.
+The stable release consists of (a) the model code including raw data and (b) the compiled data base including calibrated baselines. The model is really self contained in (a), since all software and raw data needed to compile the data bases and construct the baselines is found there. Albeit (b), the databases, can be derived from (a), doing so is a somewhat complicated process. Therefore, we provide (b) as a shortcut. Furthermore, it turns out that generating (b) may generate slightly different results on different hardware/software combinations, and therefore it is convenient to use a common versioned database release.
+The current release and selected previous releases can be downloaded as compressed (zipped) archives using the links in the following table. Note that the item "SVN-tag" only are available to developers with a an account in the SVN database. Information about each release is found in the release notes, [[Getting started with CAPRI#Release notes (cumulative)]] and in each release code base.
+^ Release   ^  Item        ^   Link                                                           ^
+| STAR 2.7  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MhJlpsZVKK4eRDCjM2w?e=gLdPBw]]  |
+| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MhJlqh8nnJYSkfOm7hw?e=5dbyr1]]  |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.7]]         |
+| STAR 2.6  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg-080EMGjf1A8H-wuQ?e=9QnIDU]]  |
+| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg-076HkDqqg6mVO0HQ?e=eD0TmO]]  |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.6]]         |
+| STAR 2.5  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg4BDjQ4AbWbXXzY1_g?e=NvyyLT]]  |
+| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-Mg4BBF3d-lsULH9gH3A?e=fIIFOd]]  |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.5]]         |
+| STAR 2.4  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgtQmzmdEn_3FuNaqyA]]           |
+| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgtQlHdUSz6F5Uv_Sgw]]           |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.4]]         |
+| STAR 1.4  |  Code        | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgpgRyPwElFGkhK5QJw]]           |
+| :::       |  Database    | [[https://1drv.ms/u/s!Aj7_RXyD8q-MgpgSo2ebWO0Y-c3oXA]]           |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/1.4]]         |
+===== System requirements =====
+CAPRI requires that you have a windows computer with Java and GAMS ([[http://www.gams.com]], distribution 32.2 or later is recommended) installed. You need a license for the CONOPT solver. Many tasks in CAPRI utilize parallel computing. It is therefore an advantage if you have a machine that can run many threads in parallel.
+Regarding Java: There are some licensing implications when using Oracle's platform. Public updates released after January 2019 will not be available for business, commercial, or production use without a commercial license. Since then the GUI for java can also be executed using a open and free installation of [[https://jdk.java.net/15/|OpenJDK]].