|
19
|
1 Orthanc - A Lightweight, RESTful DICOM Server
|
|
|
2 =============================================
|
|
|
3
|
|
|
4
|
|
|
5 General Information
|
|
|
6 ===================
|
|
|
7
|
|
|
8 This repository contains the integration tests that are used to
|
|
|
9 validate Orthanc before each official release, in complement to the
|
|
|
10 unit tests that are part of the Orthanc repository. These integrations
|
|
|
11 tests should be run by the package maintainers of the various
|
|
|
12 platforms supported by Orthanc.
|
|
|
13
|
|
|
14 General information about Orthanc can be found on its official
|
|
|
15 Website: http://www.orthanc-server.com/
|
|
|
16
|
|
|
17
|
|
|
18 Running the tests
|
|
|
19 =================
|
|
|
20
|
|
|
21 The integration tests are written in Python and are started by the
|
|
|
22 "./Tests/Run.py" script. The tests will validate a "remote" instance
|
|
|
23 of Orthanc (whose AET is "ORTHANC") that is assumed to be running
|
|
|
24 before the tests are started. To test the DICOM protocol, a second,
|
|
|
25 "local" instance of Orthanc is automatically started by the
|
|
|
26 integration tests (its AET is "ORTHANCTEST"). This situation is
|
|
|
27 depicted on the following illustration:
|
|
|
28
|
|
|
29 +--------------------------+ +-----------------------+
|
|
|
30 | Local computer | | Remote computer |
|
|
|
31 +--------------------------+ HTTP +-----------------------+
|
|
|
32 | | 5000 : 8042 | |
|
|
|
33 | Run.py <---> ORTHANCTEST <=============> ORTHANC |
|
|
|
34 | | 5001 : 4242 | |
|
|
|
35 +--------------------------+ DICOM +-----------------------+
|
|
|
36
|
|
|
37
|
|
|
38 1. Configure the remote Orthanc
|
|
|
39 -------------------------------
|
|
|
40
|
|
|
41 To run the integration tests, you first have to create a configuration
|
|
|
42 file for the remote instance of Orthanc. This is done by running the
|
|
|
43 "./GenerateConfigurationForTests.py" script on the *local*
|
|
|
44 computer. This script will autodetect the proper network parameters.
|
|
|
45 For instance (a help is available):
|
|
|
46
|
|
|
47 # ./GenerateConfigurationForTests.py --force
|
|
|
48
|
|
|
49 This will create the "./IntegrationTestsConfiguration.json"
|
|
|
50 configuration file that must be copied to the remote computer. Then,
|
|
|
51 start Orthanc on the remote computer with this configuration file.
|
|
|
52
|
|
|
53 By default, the configuration file will use "ORTHANC" as the AET, 8042
|
|
|
54 as the HTTP port, and 4242 as the DICOM port. You can of course
|
|
|
55 adapt these parameters by editing the generated configuration file,
|
|
|
56 if you have special constraints or if the autodetection fails.
|
|
|
57
|
|
|
58
|
|
|
59
|
|
|
60 Licensing
|
|
|
61 =========
|
|
|
62
|
|
|
63 The integration tests are licensed under the GPLv3 license. The sample
|
|
|
64 DICOM images contained in the "Database" folder are the property of
|
|
|
65 their respective owners, as listed in the "Database/README.txt" file.
|
|
|
66
|
|
|
67 We also kindly ask scientific works and clinical studies that make
|
|
|
68 use of Orthanc to cite Orthanc in their associated publications.
|
|
|
69 Similarly, we ask open-source and closed-source products that make
|
|
|
70 use of Orthanc to warn us about this use. You can cite our work
|
|
|
71 using the following BibTeX entry:
|
|
|
72
|
|
|
73 @inproceedings{Jodogne:ISBI2013,
|
|
|
74 author = {Jodogne, S. and Bernard, C. and Devillers, M. and Lenaerts, E. and Coucke, P.},
|
|
|
75 title = {Orthanc -- {A} Lightweight, {REST}ful {DICOM} Server for Healthcare and Medical Research},
|
|
|
76 booktitle={Biomedical Imaging ({ISBI}), {IEEE} 10th International Symposium on},
|
|
|
77 year={2013},
|
|
|
78 pages={190-193},
|
|
|
79 ISSN={1945-7928},
|
|
|
80 month=apr,
|
|
|
81 url={http://ieeexplore.ieee.org/xpl/articleDetails.jsp?tp=&arnumber=6556444},
|
|
|
82 address={San Francisco, {CA}, {USA}}
|
|
|
83 }
|
