annotate README @ 3:fdb8c6c420d0

skeleton for optimization
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 15 Jun 2023 21:18:34 +0200
parents 39585ba26f20
children 1aea0a224e90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 OHIF plugin for Orthanc
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 =======================
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 General information
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 -------------------
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 This repository contains the source code of a plugin to give access to
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 OHIF directly inside Orthanc.
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 The homepage of OHIF can be found at:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 https://ohif.org/
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 The source code of OHIF is available at:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 https://github.com/OHIF/Viewers
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 Packages for the released versions of OHIF are available at:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 https://github.com/OHIF/Viewers/tags
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 Installation and usage
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 ----------------------
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 Build and usage instructions are available in the Orthanc Book:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 http://book.orthanc-server.com/plugins/ohif.html
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 Licensing
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 ---------
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 - OHIF is licensed under the MIT license.
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 - The OHIF plugin for Orthanc is licensed under the GPL license, to
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 fulfill the GPL license of the Orthanc SDK.
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 - This project is REUSE compliant for its licensing, as established by
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 Free Software Foundation Europe (FSFE):
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 https://reuse.software/
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 Citation
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 --------
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 If you wish to cite OHIF, please refer to the following page:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 https://v3-docs.ohif.org/#citing-ohif
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 We also kindly ask scientific works and clinical studies that make
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 use of Orthanc to cite Orthanc in their associated publications.
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 Similarly, we ask open-source and closed-source products that make
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 use of Orthanc to warn us about this use. You can cite our work
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 using the following BibTeX entry:
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 @Article{Jodogne2018,
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 author="Jodogne, S{\'e}bastien",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 title="The {O}rthanc Ecosystem for Medical Imaging",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 journal="Journal of Digital Imaging",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 year="2018",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 month="Jun",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 day="01",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 volume="31",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 number="3",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 pages="341--352",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 issn="1618-727X",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 doi="10.1007/s10278-018-0082-y",
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 url="https://doi.org/10.1007/s10278-018-0082-y"
39585ba26f20 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 }