Mercurial > hg > orthanc

annotate README @ 5517:0d433132b249 pg-transactions

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring IDatabaseWrapper::Capabilities
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 29 Jan 2024 19:19:52 +0100
parents 59e3b6f8c5be
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
1 Orthanc - A Lightweight, RESTful DICOM Server
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
2 =============================================
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
3
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 General Information
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 -------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
705
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 563
diff changeset
8 General information about this software can be found on its official
4131
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
9 Website, and in the Orthanc Book:
705
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 563
diff changeset
10 http://www.orthanc-server.com/
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5370
diff changeset
11 https://orthanc.uclouvain.be/book/
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12
4131
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
13 The instructions for building Orthanc can be found in the "./INSTALL"
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 file.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 Supported Platforms
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 -------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
20 Currently, the officially validated platforms are:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
22 * GNU/Linux (32bit and 64bit).
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
23 * Windows (32bit and 64bit).
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
24 * Apple OS X (32bit and 64bit).
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
26 Orthanc is known to work on other UNIX-like platforms (such as FreeBSD
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
27 and OpenBSD).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
28
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 Supported Toolchains
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 --------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
33 Orthanc can currently be built using the following compiling
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 toolchains:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
36 * Native GNU/Linux compilation, with gcc.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
37 * Native Windows compilation, with Microsoft Visual Studio.
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
38 * Cross-compilation for Windows under GNU/Linux, with MinGW.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
5370
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
41 Contributing
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
42 ------------
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
43
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
44 Instructions for contributing to the Orthanc project are included in
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
45 the Orthanc Book:
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5370
diff changeset
46 https://orthanc.uclouvain.be/book/developers/repositories.html
5370
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
47
1f7ac929e788 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4345
diff changeset
48
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
49 Licensing
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
50 ---------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
51
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
52 Orthanc is licensed under the GPLv3 license, with the OpenSSL
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
53 exception:
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
54 http://people.gnome.org/~markmc/openssl-and-the-gpl.html
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
55
4345
7822fa96f9c8 fix travis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4131
diff changeset
56 Full information about the licensing of the Orthanc ecosystem is
7822fa96f9c8 fix travis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4131
diff changeset
57 available in the Orthanc Book:
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5370
diff changeset
58 https://orthanc.uclouvain.be/book/faq/licensing.html
4345
7822fa96f9c8 fix travis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4131
diff changeset
59
1230
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
60 We also kindly ask scientific works and clinical studies that make
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
61 use of Orthanc to cite Orthanc in their associated publications.
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
62 Similarly, we ask open-source and closed-source products that make
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
63 use of Orthanc to warn us about this use. You can cite our work
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
64 using the following BibTeX entry:
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
65
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
66 @Article{Jodogne2018,
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
67 author="Jodogne, S{\'e}bastien",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
68 title="The {O}rthanc Ecosystem for Medical Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
69 journal="Journal of Digital Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
70 year="2018",
2613
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
71 month="Jun",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
72 day="01",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
73 volume="31",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
74 number="3",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
75 pages="341--352",
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
76 issn="1618-727X",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
77 doi="10.1007/s10278-018-0082-y",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
78 url="https://doi.org/10.1007/s10278-018-0082-y"
449
694f06a84bf4 licensing notes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
79 }
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
80
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
81
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
82 Licensing of special directories
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
83 --------------------------------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
84
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
85 The following directories have separate licensing terms:
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
86
4131
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
87 * The files of the "./OrthancFramework/Sources/" directory are
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
88 licensed under the LGPLv3 (Lesser GPL) since Orthanc 1.7.2. The
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
89 related COPYING file can be found in "./OrthancFramework".
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
90
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
91 * The files of the "./OrthancFramework/Sources/SQLite/" directory are
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
92 licensed under the 3-clause BSD license, as they are derived from
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
93 the Chromium project.
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
94
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
95
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 Content
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 -------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
99 This archive contains the following important directories:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
4131
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
101 * ./OrthancFramework/Sources/ - The sources of the Orthanc framework
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
102 * ./OrthancFramework/UnitTestsSources/ - Unit tests of the Orthanc framework
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
103 * ./OrthancServer/OrthancExplorer/ - Code of the Orthanc Explorer (HTML5/Javascript)
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
104 * ./OrthancServer/Plugins/ - Code of the plugin framework
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
105 * ./OrthancServer/Resources/Samples/ - Samples
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
106 * ./OrthancServer/Sources/ - Code of the Orthanc server (depends on DCMTK)
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
107 * ./OrthancServer/UnitTestsSources/ - Unit tests of the Orthanc server
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
109 This archive contains the following important files:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
4131
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
111 * ./AUTHORS - The list of the authors
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
112 * ./COPYING - The main GPLv3 license
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
113 * ./INSTALL - How to build Orthanc
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
114 * ./NEWS - The history of main changes between versions
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
115 * ./OrthancServer/CMakeLists.txt - The main build script of the Orthanc server
eea760f20ed2 Orthanc-1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4091
diff changeset
116 * ./README - This file
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
118 We have decided not to maintain a separate "ChangeLog" file. Each
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
119 commit to the official Orthanc Mercurial repository should be
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
120 associated with a description of the changes.