Mercurial > hg > orthanc-book
annotate Sphinx/source/contributing.rst @ 562:7ed565d4d89b
sponsor
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 16 Dec 2020 11:09:31 +0100 |
parents | e9d8c7e5afbd |
children | 036047f89dec |
rev | line source |
---|---|
24 | 1 .. _contributing: |
2 | |
481
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
3 |
0 | 4 Contributing to Orthanc |
5 ======================= | |
6 | |
481
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
7 .. toctree:: |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
8 :hidden: |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
9 |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
10 unanswered-forum.rst |
562 | 11 |
12 | |
13 .. note:: Here are the main features we would like to get soon | |
14 implemented as free and open-source code in the Orthanc | |
15 ecosystem. To make this happen, **we need your financial | |
16 support**! | |
17 | |
18 * **Orthanc Core**: | |
19 | |
20 - DICOM TLS | |
21 - Scalability of the PostgreSQL database | |
22 | |
23 * **Stone Web viewer**: | |
24 | |
25 - Annotations/measurements | |
26 - Internationalization/translations | |
27 - MPR volume rendering | |
28 - CE certification | |
29 | |
30 Please `get in touch with Osimis <info@osimis.io>`__ if you | |
31 want to sponsor these developments. | |
481
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
32 |
0 | 33 If you find Orthanc useful and wish to contribute to its development, |
34 here are some tasks you can take in charge that would greatly help us: | |
35 | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
36 * **Non-coding tasks**: |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
37 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
38 - Use Orthanc in the real life. ;) |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
39 - Advertise about Orthanc, notably on social networks (we are active |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
40 on `Facebook <https://www.facebook.com/orthancdicom/>`__ and |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
41 `Twitter <https://twitter.com/OrthancServer>`__). |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
42 - Answer our `survey |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
302
diff
changeset
|
43 <https://www.orthanc-server.com/static.php?page=blog#survey>`_. |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
44 - Improve and translate the `Wikipedia pages |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
45 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc. |
174 | 46 - Cite the `reference paper about Orthanc |
47 <https://link.springer.com/article/10.1007/s10278-018-0082-y>`__ | |
48 in your research work. | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
49 - Answer questions posted to the `mailing list |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
50 <https://groups.google.com/forum/#!forum/orthanc-users>`_. |
481
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
51 |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
52 - **Important**: A page list the :ref:`old questions that are not |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
53 fully answered yet <unanswered_forum>`. Consider answering these |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
54 topics too! |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
480
diff
changeset
|
55 |
269 | 56 - Improve the text of the `Orthanc Book and REST API documentation |
449 | 57 <https://hg.orthanc-server.com/orthanc-book/file/default>`__ (check |
361 | 58 out the instructions provided in the `README file |
449 | 59 <https://hg.orthanc-server.com/orthanc-book/file/default/README.md>`__, |
361 | 60 and send us a :ref:`simple patch <hg-patch>`). |
473 | 61 - Pursue the `OpenAPI documentation |
62 <https://api.orthanc-server.com/>`__, that is still | |
63 work-in-progress (`check out its source code | |
64 <https://hg.orthanc-server.com/orthanc-book/file/default/OpenAPI>`__). | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
65 - Provide documentation and use cases (inside the dedicated `GitHub |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
66 repository <https://github.com/jodogne/OrthancContributed>`_, via |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
67 pull requests). |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
68 - Index external contributions inside the `Links.md |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
69 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_ |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
70 file. |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
71 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
72 * **Maintenance tasks**: |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
73 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
74 - Report problems together with sample DICOM images and possible |
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
361
diff
changeset
|
75 workarounds on the dedicated `issue tracker |
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
361
diff
changeset
|
76 <http://bugs.orthanc-server.com/>`_. |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
77 - Package Orthanc and its associated plugins for more UNIX or |
473 | 78 GNU/Linux distributions (e.g. Ubuntu PPA, RHEL/`EPEL |
79 <https://fedoraproject.org/wiki/EPEL>`__, CentOS, openSUSE...). | |
80 - Take ownership of the now-orphaned `Fedora package | |
81 <https://src.fedoraproject.org/rpms/orthanc>`__. | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
82 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
83 <https://github.com/jodogne/OrthancContributed>`_" public GitHub |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
84 repository, via pull requests. |
473 | 85 - Help with the integration of Orthanc together with our friend free |
86 and open-source projects, notably `GNU Health | |
87 <https://www.orthanc-server.com/resources/orthanccon2019/GNUHealthCon-02-AxelBraun.pdf>`__, | |
88 but also `OpenEMR | |
89 <https://community.open-emr.org/t/project-pacs-server-integration/13706/15>`__, | |
90 `GNUmed <https://en.wikipedia.org/wiki/GNUmed>`__... | |
91 | |
0 | 92 |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
93 * **Coding tasks**: |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
94 |
204 | 95 - The Orthanc project will happily accept patches in the core of |
96 Orthanc and in its associated official plugins. Please read the | |
97 :ref:`dedicated FAQ entry <cla>`. | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
98 - Interface Orthanc with other software (e.g. 3D Slicer, |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
99 Matlab/Octave, Python, Horos, dicompyler...). Check the `already |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
302
diff
changeset
|
100 supported frameworks <https://www.orthanc-server.com/static.php?page=resources>`_. |
473 | 101 - Develop :ref:`C/C++/Python plugins extending the Orthanc core <plugins>`. Here are some ideas |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
102 of possible plugins: |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
103 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
104 + Create a :ref:`more advanced Web interface |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
105 <improving-interface>` than the built-in Orthanc Explorer. |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
106 + Extend the :ref:`sample modality worklist plugin <worklist>` so |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
107 that it manages the worklists (i.e. add/remove items) with a |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
108 REST API or HL7 messages, instead of reading them from some |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
109 folder on the filesystem. |
473 | 110 + Conversion to/from `NIfTI |
111 <https://www.sciencedirect.com/science/article/abs/pii/S0165027016300073?via%3Dihub>`__ | |
112 and/or `BIDS | |
113 <https://en.wikipedia.org/wiki/Brain_Imaging_Data_Structure>`__, | |
114 notably for neuroimaging. | |
479 | 115 + `Encapsulate a video into a DICOM file |
116 <https://stackoverflow.com/questions/28698888/creating-h-264-avc-dicom-file-with-dcmtk/28737338#28737338>`__ | |
480 | 117 by calling some REST route, similarly to the |
118 ``/tools/create-dicom`` :ref:`route to encapsulate PDF <pdf>`. | |
496 | 119 + Similarly to video and PDF (cf. item above), `wrap/unwrap a STL |
120 (3D mesh) to/from a DICOM file | |
121 <http://dicom.nema.org/medical/dicom/2020b/output/chtml/part03/sect_A.85.html>`__ | |
122 by calling some REST route. This is notably useful for dentistry | |
123 (dental implants) or orthopaedics, yet even cutting-edge | |
124 research about 3D-printing of organs. In complement, provide a | |
125 `FreeCAD extension | |
126 <https://twitter.com/sjodogne/status/1299632772915625984>`__ to | |
127 import/export such STL files from/to Orthanc. | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
128 + Have a look at the TODO file containing our `official roadmap |
360 | 129 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. |
473 | 130 |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
131 - Always remember that he **recommended way of contributing to the |
474 | 132 source code of Orthanc is by creating C/C++/Python plugins, or by |
133 creating external software that use the REST API**. If the current | |
134 plugin SDK is insufficient for you to develop some feature as a | |
135 plugin, do not hesitate to request an extension to the Orthanc SDK | |
136 on the `mailing list | |
104
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
137 <https://groups.google.com/forum/#!forum/orthanc-users>`_. |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
138 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
139 |
09b0a61f1942
improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
86
diff
changeset
|
140 * **Financial support**: |
0 | 141 |
475
5202bb6984dc
links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
474
diff
changeset
|
142 - Osimis provides `support packs and professional development |
5202bb6984dc
links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
474
diff
changeset
|
143 services <https://www.osimis.io/en/services.html>`__ around the |
5202bb6984dc
links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
474
diff
changeset
|
144 Orthanc ecosystem and, more generally, around medical |
5202bb6984dc
links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
474
diff
changeset
|
145 imaging. Buying such professional services is the best way to make |
5202bb6984dc
links to lify and OrthancToolsJS
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
474
diff
changeset
|
146 the Orthanc project sustainable in the long term. |