Differences

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

--- getting_started_with_capri [2021/05/24 09:59] – [Build databases and baselines] Revising instructions for building the database torbjornj
+++ getting_started_with_capri [2025/04/22 14:13] (current) – [Installing CAPRI Stable Release 2 and earlier] gocht
@@ Line 1: / Line 1: @@
 ======Getting started with CAPRI======
+===== Installing CAPRI Stable Release 2 and earlier =====
+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.8, they are called "STAR_2.8.zip" and "results_2.8.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.
+=== Attention ===
+CAPRI Stable Release 2 is not very up-to-date. You can, of course, continue to use these versions, but if you want to work with a CAPRI version that includes features developed in the main until May 2024, you should use the version that is used in the CAPRI Course.
+** For downloading the latest 2024 CAPRI version used in the CAPRI course please [[https://www.capri-model.org/ts/dokuwiki/doku.php?id=start|External Link]] **
+==== 1. Ensure that you have Java and GAMS installed on your computer (only required for version until star 2.7) ====
+See [[getting_started_with_capri#system_requirements|system requirements]].
+Note: CAPRI version star 2.8 includes a GAMS version and a java version in the package (STAR_2.8.zip). No installation of gams or java is required.
+==== 2. Download the two archives ====
+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/Start_2_8''.
+  - Extract the files of the compressed archive with code, e.g. ''STAR_2.8.zip'' into the CAPRI system folder.
+  - Extract the files of the compressed archive with data, e.g. ''results_2.8.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:
+{{:wiki:installation_folders_tier1.png?nolink&400|}}
+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}}
+==== 4. Adjust the settings to your computer ====
+  - Go to the subfolder "GUI", double-click “start_capri.bat”. That should open the graphical user interface (GUI). If not, something is wrong with your Java-installation.
+  - In the menu **settings**, choose **Edit settings.**
+    * In the first tab: enter your name
+    * In the second tab: verify that the paths to result and restart folders are set to **../output/results and ../output/restart.** The GAMS directory should read **../gams** and the data directory should read **../dat.**
+    * In the third tab: enter the complete path to the GAMS executable. Probably it is something like **../GUI/gams_exe/34.3/gams.exe.** Also verify that the path to the Scratch directory is **../output/temp.** Click the button to “get number of processors”.
+    * In the fourth tab: do nothing.
+    * In the final tab: do nothing, or, if you have a programming text editor, enter the path to that editor in the proper field.
+  - 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 =====
@@ Line 9: / Line 53: @@
 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                                                           ^
+^ Release   ^  Item   ^   Link   ^
+| STAR 2.8  |  Code        | [[https://cloud.capri-model.org/index.php/s/bF22wSsjKt5YPCL]]  |
+| :::       |  Database    | [[https://cloud.capri-model.org/index.php/s/YoTPepRiFDYAiT4]]  |
+| :::       |  SVN-tag     | [[https://svn1.agp.uni-bonn.de/svn/capri/tags/star/2.8.1]]  |
 | 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]]  |
@@ Line 30: / Line 79: @@
 ===== 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.
+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]].
-===== Installing CAPRI Stable Release 2 and earlier =====
+Note: From Star 2.8 java is embedded in star2.8.zip. There is no additional installation of java JRE necessary.
-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.
-==== 1. Ensure that you have Java and GAMS installed on your computer ====
-See [[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.
-==== 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"
-  - 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.
-==== 4. Adjust the settings to your computer ====
-  - Go to the subfolder "GUI", double-click “start_capri.bat”. That should open the graphical user interface (GUI). If not, something is wrong with your Java-installation.
-  - In the menu **settings**, choose **Edit settings.**
-    * In the first tab: enter your name
-    * In the second tab: verify that the paths to result and restart folders are set to **../output/results and ../output/restart.** The GAMS directory should read **../gams** and the data directory should read **../dat.**
-    * In the third tab: enter the complete path to the GAMS executable. Probably it is something like **c:/gams/win64/30.3/gams.exe.** Also verify that the path to the Scratch directory is **../output/temp.** Click the button to “get number of processors”.
-    * In the fourth tab: do nothing.
-    * In the final tab: do nothing, or, if you have a programming text editor, enter the path to that editor in the proper field.
-  - 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.
@@ Line 80: / Line 102: @@
 The current batch execution file (STAR 2.7) does not take over the path to your GAMS installation as entered in the settings dialogue during installation, but you will have to open the text file and enter the appropriate path manually.
 ===== Release notes (cumulative) =====
+=== STAR 2.8 ===
+Main update relates to the GUI folder by embedded java/gams version, some more minor issues below:
+- empty folder problem with ziped files avoided by includeing void.gdx files in gams/temp and userScen in gams/temp
+- scenario for import ban included
+- BREXIT mode standard setting in capri_gui_definition.xml
+- Edits to avoid non unique names in controls in capri_gui_definition.xml
+- Inflation_and_trend_interpolation.gms adjusted that also comi prices can be simulated
+- batch file adjusted in FAO split into two separate tasks as in the trunk to improve stability
 === STAR 2.7 ===
@@ Line 215: / Line 249: @@
 already in various projects, but the modifications need to be consolidated and integrated into a maintenance release. Similar improvements have accumulated
 in the areas of market model tariff data and greenhouse gas emissions, also foreseen to be integrated in a future maintenance release, after thorough testing.
-===== Trunk result files for download by revision =====
-^ Result folder zip                    ^trunk revision   ^ Date        ^ batch file ^
-|{{:beta:res_8300.zip|Download link}}  |8300              | 24.10.2020 |[[https://svn1.agp.uni-bonn.de/!/#capri/view/head/trunk|External Link]]|
-|{{:beta:res_8872.zip|Download link}}  |8872              | 04.10.2020 |[[https://svn1.agp.uni-bonn.de/!/#capri/view/head/trunk|External Link]]|