Mercurial > hg > orthanc-book

annotate Sphinx/source/users/cookbook.rst @ 769:48f158c9ecb2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Sep 2021 07:43:39 +0200
parents d5a646b2b421
children db20ad016bc2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 .. _cookbook:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 Quickstart
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 ==========
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 .. contents::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 :depth: 2
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
dc235678897c webviewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 26
diff changeset
12
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 Obtaining binaries
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 ------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 To obtain the Orthanc binaries, you have several possibilities:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
b78e8bf4d021 opensuse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
20 * On GNU/Linux, use precompiled packages for :ref:`Debian/Ubuntu
573
063c832d8f99 fix link
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 572
diff changeset
21 <debian-packages>`, or for `openSUSE
063c832d8f99 fix link
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 572
diff changeset
22 <https://software.opensuse.org/search?q=orthanc>`__ (courtesy of
063c832d8f99 fix link
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 572
diff changeset
23 Axel Braun).
574
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 573
diff changeset
24 * On GNU/Linux, use our `LSB binaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 573
diff changeset
25 <https://lsb.orthanc-server.com/>`__ (Linux Standard Base), that
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 573
diff changeset
26 should easily and immediately run on most distributions. Those
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 573
diff changeset
27 binaries are statically linked together with all their third-party
669
d5a646b2b421 chmod x
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 574
diff changeset
28 dependencies. Don't forget to execute ``chmod +x ./Orthanc`` in
d5a646b2b421 chmod x
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 574
diff changeset
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
7f98cfa8708f docker, upload issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
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
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 .. _orthanc-explorer:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 Opening Orthanc Explorer
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 ------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 The most straightforward way to use Orthanc consists in opening
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 **Orthanc Explorer**, the embedded administrative interface of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 Orthanc, with a Web browser. Once Orthanc is running, open the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 following URL: http://localhost:8042/app/explorer.html. Please note
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 that:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 * The port number 8042 depends on your :ref:`configuration
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 <configuration>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 * Orthanc Explorer does not work with Microsoft Internet
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 Explorer. Please use Mozilla Firefox, Google Chrome, Apple Safari,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 or `any WebKit-based Web browser <https://en.wikipedia.org/wiki/WebKit>`__.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 Uploading DICOM files
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 ---------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 The Orthanc Explorer interface contains a user-friendly page to upload
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 DICOM files. You can reach the upload page at
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 http://localhost:8042/app/explorer.html#upload. Then, you can drag and
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 drop your DICOM files and click on the Upload button.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 You can `watch this video tutorial
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 <https://www.youtube.com/watch?v=4dOcXGMlcFo&hd=1>`__ that shows how
26
7f98cfa8708f docker, upload issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
63 to upload files to Orthanc through Orthanc Explorer with Chromium.
7f98cfa8708f docker, upload issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
64
7f98cfa8708f docker, upload issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
65 **Important:** There is currently a `known issue
445
987fbbc2b59e leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
66 <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
67 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
68 drag-and-drop.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 Uploading through the DICOM protocol
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 ------------------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 Once Orthanc is up and running, any imaging modality can send
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 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
76 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
77 connect your modality to Orthanc.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
292
8aa416899db4 added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents: 54
diff changeset
79 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
80 `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
81 send DICOM images to Orthanc, for instance::
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 $ storescu -aec ORTHANC localhost 4242 *.dcm
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 will send all the files with ".dcm" extension to the instance of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 Orthanc that is running on the ``localhost``, whose application entity
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 title (AET) is ``ORTHANC``, and whose DICOM port is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 ``4242``. Obviously, all these parameters depend on your
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 :ref:`configuration <configuration>`. Please check the :ref:`FAQ
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 <dicom>` if you encounter any problem.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 Next steps
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 ----------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 1. Read the general introduction ":ref:`dicom-guide`".
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 2. Have a look at your :ref:`configuration file <configuration>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 3. Drive Orthanc through its :ref:`REST API <rest>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 4. Automate DICOM tasks with :ref:`Lua scripts <lua>`.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100