Mercurial > hg > orthanc-book

annotate Sphinx/source/faq/improving-interface.rst @ 1113:a588960a72e5 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
spelling
author Alain Mazy <am@orthanc.team>
date Mon, 28 Oct 2024 09:23:08 +0100
parents c9d2ae104b1b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
98c0c61e7931 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
1 .. _improving-interface:
98c0c61e7931 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
2
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Orthanc Explorer is not user-friendly enough for my use
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 =======================================================
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 Orthanc is designed as a lightweight service for medical imaging,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 where the word *service* must be understood in the sense of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 `service-oriented architectures
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 <https://en.wikipedia.org/wiki/Service-oriented_architecture>`__. As
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 a consequence, Orthanc is conceived as a robust back-end server
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 (command-line) that aims to provide the most simple and generic
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 support of DICOM. To state it differently, **the primary focus of the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 Orthanc project is not on the user interface**.
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 However, Orthanc comes out-of-the-box with :ref:`Orthanc Explorer
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 <orthanc-explorer>`, its default Web user interface. **Orthanc
433
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
17 Explorer is designed for development, low-level purpose.** It is
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 also used by the development team to test the features of Orthanc as
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 they get introduced in the REST API. Orthanc Explorer is mainly
68
7c90ecd41c6f translation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 22
diff changeset
20 targeted towards an English-speaking technical audience (notably
7c90ecd41c6f translation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 22
diff changeset
21 system/network engineers, `PACS
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 <https://en.wikipedia.org/wiki/Picture_archiving_and_communication_system>`__
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 managers, medical physicists, and researchers).
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 **Non-technical audience** (physicists, patients, administrative
924
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
26 staff...) **shall have a look at** :ref:`Orthanc Explorer 2 <orthanc-explorer-2>`
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
27 **plugin** that provides a more friendly user interface including:
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
28
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
29 - translations
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
30 - modification and tunable anonymization
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
31 - configurable interface
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
924
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
33 Once integrated with the `orthanc-auth-service <https://github.com/orthanc-team/orthanc-auth-service>`__
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
34 companion web service, Orthanc Explorer 2 also offers:
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
35
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
36 - user permissions
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
37 - web diffusion to patients/physicians
Alain Mazy <am@osimis.io>
parents: 845
diff changeset
38
456
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
39
845
bf3946cb3ca0 Orthanc Explorer 2
Alain Mazy <am@osimis.io>
parents: 784
diff changeset
40 Finally, you may also have a look to the following **related projects**:
117
0a52547bc919 proj0010
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 68
diff changeset
41
456
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
42 * In 2017-2018, a team of Master students from `ULiège
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
43 <https://www.uliege.be/>`__ has done some work about creating a
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
44 revamped version of Orthanc Explorer. Check out the `related
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
45 discussion
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
46 <https://groups.google.com/d/msg/orthanc-users/oOyKTmfs-J0/B6eyBJcvCAAJ>`__
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
47 on the Orthanc Users forum.
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
48
475
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
49 * `Orthanc Tools <https://github.com/salimkanoun/Orthanc_Tools>`__, a
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
50 desktop Java interface around the REST API of Orthanc by Salim
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
51 Kanoun. Orthanc Tools was notably showcased during `OrthancCon 2019
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
52 <https://www.orthanc-server.com/static.php?page=conference-schedule>`__.
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
53
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
54 * `OrthancToolsJS <https://github.com/salimkanoun/Orthanc-Tools-JS>`__
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
55 is the successor of the now-deprecated Orthanc Tools. This Web
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
56 interface was also created by Salim Kanoun. For more information,
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
57 including link to a demo server, `check out the announcement
476
998d302a2537 announcement of android
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 475
diff changeset
58 <https://groups.google.com/forum/#!msg/orthanc-users/L1BqXbD900E/CB8wOnQ_AwAJ>`__
475
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
59 on the discussion group.
456
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
60
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 434
diff changeset
61 * The `Orthanc Manager <https://github.com/id-05/OrthancManager>`__
476
998d302a2537 announcement of android
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 475
diff changeset
62 Android application. `Check out the announcement
998d302a2537 announcement of android
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 475
diff changeset
63 <https://groups.google.com/forum/#!msg/orthanc-users/ToG4kbhK4Ss/CdFaexyvBwAJ>`__
998d302a2537 announcement of android
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 475
diff changeset
64 on the discussion group.
475
5202bb6984dc links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 456
diff changeset
65
510
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
66 * `Elessar Theme for Orthanc <https://github.com/Terabuck/Elessar>`__
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
67 by Ludwig Moreno. This PHP project notably provide a green and dark
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
68 grey theme, and translation in 14 languages. `Check out the full
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
69 announcement
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
70 <https://groups.google.com/g/orthanc-users/c/Kkxqx6ZW2yw/m/dFbTuHZHCQAJ>`__
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
71 on the discussion group.
7cb4e27f9f3e elessar
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 478
diff changeset
72
670
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
73 * `Menba <https://github.com/fidelio33b/menba>`__ is a Web interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
74 built on the top of the REST API of Orthanc. It is written using
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
75 `Django <https://www.djangoproject.com/>`__ and `Bootstrap
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
76 <https://getbootstrap.com/>`__, and takes advantage of `Celery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
77 <https://docs.celeryproject.org/en/stable/getting-started/introduction.html>`__
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
78 and `AMQP
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
79 <https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol>`__
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 510
diff changeset
80 to handle the asynchronous tasks.