Mercurial > hg > orthanc-book
annotate Sphinx/source/users/cookbook.rst @ 803:f3caa014eb88
note about Python plugin in the standalone Debian repo
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 24 Dec 2021 15:18:22 +0100 |
parents | db20ad016bc2 |
children | 815f70009ec2 |
rev | line source |
---|---|
0 | 1 .. highlight:: bash |
2 .. _cookbook: | |
3 | |
4 Quickstart | |
5 ========== | |
6 | |
7 .. contents:: | |
8 :depth: 2 | |
9 | |
10 | |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
28
diff
changeset
|
11 .. _binaries: |
28 | 12 |
0 | 13 Obtaining binaries |
14 ------------------ | |
15 | |
16 To obtain the Orthanc binaries, you have several possibilities: | |
17 | |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
18 * `Download pre-compiled packages <https://www.orthanc-server.com/download.php>`__. |
54
bd0fbf1f0143
docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
31
diff
changeset
|
19 * :ref:`Use Docker <docker>`. |
572 | 20 * On GNU/Linux, use precompiled packages for :ref:`Debian/Ubuntu |
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
21 <debian-packages>` (courtesy of DebianMed and Sébastien Jodogne), or |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
22 for `openSUSE <https://software.opensuse.org/search?q=orthanc>`__ |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
23 (courtesy of Axel Braun). |
574 | 24 * On GNU/Linux, use our `LSB binaries |
25 <https://lsb.orthanc-server.com/>`__ (Linux Standard Base), that | |
26 should easily and immediately run on most distributions. Those | |
27 binaries are statically linked together with all their third-party | |
669 | 28 dependencies. Don't forget to execute ``chmod +x ./Orthanc`` in |
29 order to be able to run the main Orthanc executable. | |
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
30 * :ref:`Compile Orthanc by yourself <compiling>`. |
26 | 31 * External contributors are also maintaining `Vagrant VM for Orthanc |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
32 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md#user-content-vagrant>`__. |
0 | 33 |
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
34 .. highlight:: bash |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
35 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
36 Furthermore, if you are running Debian 9 (stretch), Debian 10 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
37 (buster), Debian 11 (bullseye), Ubuntu 18.04 LTS (bionic) or Ubuntu |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
38 20.04 LTS (focal) on an **AMD64 architecture**, Sébastien Jodogne |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
39 maintains a **standalone Debian repository** that provides the latest |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
40 versions of the LSB binaries. For instance, here is how to install the |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
41 :ref:`Stone Web viewer <stone_webviewer>` on a barebone Docker setup:: |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
42 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
43 # docker run --rm -t -i -p 8042:8042 -p 4242:4242 debian:9 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
44 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
45 $ apt update |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
46 $ DEBIAN_FRONTEND=noninteractive apt install -y software-properties-common wget curl nano gnupg apt-transport-https |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
47 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
48 $ apt install --upgrade ca-certificates |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
49 $ wget -qO - https://debian.orthanc-labs.com/archive.key | apt-key add - |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
50 $ apt-add-repository "deb https://debian.orthanc-labs.com/ `grep VERSION_CODENAME /etc/os-release | cut -d'=' -f 2` main" |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
51 |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
52 $ apt clean && apt update |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
53 $ apt install orthanc-stone-webviewer |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
54 $ /etc/init.d/orthanc start |
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
55 |
803
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
56 Note that this standalone Debian repository **does not** contain the |
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
57 :ref:`Python plugin <python-plugin>`, as this plugin must be |
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
58 dynamically linked against the system-wide version of your Python |
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
59 runtime. You should install the ``orthanc-python`` package from your |
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
60 native Debian/Ubuntu distribution if available, or compile the plugin |
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
61 from sources. |
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
62 |
0 | 63 |
64 .. _orthanc-explorer: | |
65 | |
66 Opening Orthanc Explorer | |
67 ------------------------ | |
68 | |
69 The most straightforward way to use Orthanc consists in opening | |
70 **Orthanc Explorer**, the embedded administrative interface of | |
71 Orthanc, with a Web browser. Once Orthanc is running, open the | |
72 following URL: http://localhost:8042/app/explorer.html. Please note | |
73 that: | |
74 | |
75 * The port number 8042 depends on your :ref:`configuration | |
76 <configuration>`. | |
77 * Orthanc Explorer does not work with Microsoft Internet | |
78 Explorer. Please use Mozilla Firefox, Google Chrome, Apple Safari, | |
79 or `any WebKit-based Web browser <https://en.wikipedia.org/wiki/WebKit>`__. | |
80 | |
81 | |
82 Uploading DICOM files | |
83 --------------------- | |
84 | |
85 The Orthanc Explorer interface contains a user-friendly page to upload | |
86 DICOM files. You can reach the upload page at | |
87 http://localhost:8042/app/explorer.html#upload. Then, you can drag and | |
88 drop your DICOM files and click on the Upload button. | |
89 | |
90 You can `watch this video tutorial | |
91 <https://www.youtube.com/watch?v=4dOcXGMlcFo&hd=1>`__ that shows how | |
26 | 92 to upload files to Orthanc through Orthanc Explorer with Chromium. |
93 | |
94 **Important:** There is currently a `known issue | |
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
95 <https://bugs.orthanc-server.com/show_bug.cgi?id=21>`__ that might |
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
96 prevent Mozilla Firefox to correctly upload all DICOM files if using |
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
97 drag-and-drop. |
0 | 98 |
99 | |
100 Uploading through the DICOM protocol | |
101 ------------------------------------ | |
102 | |
103 Once Orthanc is up and running, any imaging modality can send | |
104 instances to Orthanc through the DICOM protocol (with the C-Store | |
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
105 command). Check :ref:`this tutorial <configure-modality>` to |
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
106 connect your modality to Orthanc. |
0 | 107 |
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
108 You can also use the standard command-line tool ``storescu`` from the |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
109 `DCMTK software <https://dicom.offis.de/dcmtk.php.en>`__ to manually |
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
110 send DICOM images to Orthanc, for instance:: |
0 | 111 |
112 $ storescu -aec ORTHANC localhost 4242 *.dcm | |
113 | |
114 will send all the files with ".dcm" extension to the instance of | |
115 Orthanc that is running on the ``localhost``, whose application entity | |
116 title (AET) is ``ORTHANC``, and whose DICOM port is | |
117 ``4242``. Obviously, all these parameters depend on your | |
118 :ref:`configuration <configuration>`. Please check the :ref:`FAQ | |
119 <dicom>` if you encounter any problem. | |
120 | |
121 | |
122 Next steps | |
123 ---------- | |
124 | |
125 1. Read the general introduction ":ref:`dicom-guide`". | |
126 2. Have a look at your :ref:`configuration file <configuration>`. | |
127 3. Drive Orthanc through its :ref:`REST API <rest>`. | |
128 4. Automate DICOM tasks with :ref:`Lua scripts <lua>`. | |
129 |