-
Notifications
You must be signed in to change notification settings - Fork 10
/
README.ICE
57 lines (45 loc) · 3.64 KB
/
README.ICE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/**
* Copyright (C) 2024 New York City Department of Health and Mental Hygiene, Bureau of Immunization
* Contributions by HLN Consulting, LLC
*
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU
* Lesser General Public License as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version. You should have received a copy of the GNU Lesser
* General Public License along with this program. If not, see <http://www.gnu.org/licenses/> for more
* details.
*
* The above-named contributors (HLN Consulting, LLC) are also licensed by the New York City
* Department of Health and Mental Hygiene, Bureau of Immunization to have (without restriction,
* limitation, and warranty) complete irrevocable access and rights to this project.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; THE
*
* SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING,
* BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, IF ANY, OR DEVELOPERS BE LIABLE FOR
* ANY CLAIM, DAMAGES, OR OTHER LIABILITY OF ANY KIND, ARISING FROM, OUT OF, OR IN CONNECTION WITH
* THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* For more information about this software, see http://www.hln.com/ice or send
* correspondence to ice@hln.com.
*/
ICE is open source software and in active development. Please check in to http://www.cdsframework.org/ for the latest status, or e-mail questions to ice@hln.com.
An overview of the capabilities of ICE is available http://www.hln.com/ice/. This distribution comes bundled with OpenCDS 6.2.0, which was released in May 2024. The ICE software will continually update to the latest versions of OpenCDS as they become available. The out of the box (default) immunization rules documentation, as well as technical documentation for ICE and CAT, can be found at http://www.cdsframework.org/.
This version of ICE requires Java 17, and has been tested under the latest version of Tomcat 10.
It is recommended that at least 1GB of memory be allocated to the Tomcat instance, though in our internal performance tests, we have noted a significant performance increase when allocating 2GB of memory.
To install the software, please follow the directions at https://cdsframework.atlassian.net/wiki/display/ICE/Installing+ICE to configure and interact with the service. The out-of-the-box working ICE service executable is available at this location.
Alternatively, to build the software via source:
1) Edit .gcp.config/opencds.properties to suit your installation.
+ Set km.threads to specify the number of threads allocated to each knowledgeModule. Recommended setting: twice the number of CPU cores available to this instance for Linux; equal to the number of CPU cores for Windows
+ Set knowledge-repository.path to the location of the ICE knowledge repository as follows: /path/to/opencds-ice-service/src/main/resources
2) Copy opencds.properties to $HOME/.opencds/, where $HOME is the "home" directory of the application server instance.
3) Edit opencds-ice-service/src/main/resources/ice.properties:
+ Set ice_knowledge_repository_location to the same location as knowledge-repository.path of opencds.properties file
4) Edit opencds-ice-service/src/main/resources/log4j2.xml to suit your installation.
5) Compile the software:
$ cd opencds
$ mvn clean
$ mvn -DskipTests -DskipITs -Djetty.skip=true install
$ cd ..
$ mvn clean
$ mvn -DskipTests -DskipITs -Djetty.skip=true install