Debian Codegraph @

doc/index.rst

raw
1 DataLab
2 =======
3
4 .. meta::
5 :description: Home of DataLab, the open-source platform for scientific and technical data processing and visualization
6 :keywords: DataLab, scientific, data, processing, visualization, open-source, platform, Python, Qt, NumPy, SciPy, scikit-image, OpenCV, PlotPyStack, Sigima, CODRA, Pierre Raybaut
7
8 DataLab is an **open-source platform for signal and image processing and visualization**
9 for research, education and industry. Leveraging the richness of the scientific Python
10 ecosystem [#f1]_, DataLab is the ideal complement to your data analysis workflows as it
11 can be extended with your Python code through :bdg-ref-success-line:`Plugins <about_plugins>`
12 or directly from :ref:`your IDE <use_cases>` or :ref:`your Jupyter notebooks <use_cases>`.
13 Go to :bdg-ref-success-line:`Installation <installation>` to get started!
14
15 .. only:: html and not latex
16
17 .. dropdown:: Notice for users upgrading from DataLab v0.20
18 :animate: fade-in
19 :icon: alert
20
21 DataLab v1.0 introduces breaking changes. Plugins must be updated to work with the new version. See the :ref:`migration guide <migration_v020_to_v100>` for details.
22
23 .. only:: html and not latex
24
25 :octicon:`play;1em;sd-text-info` Want to know more?
26 See our :bdg-ref-success-line:`Tutorials <tutorials>` --
27 Try DataLab online, without installation: :octicon:`rocket;1em;sd-text-info` |binder|.
28
29 .. |binder| image:: https://mybinder.org/badge_logo.svg
30 :target: https://mybinder.org/v2/gh/DataLab-Platform/DataLab/binder-environments?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FDataLab-Platform%252FDataLab%26urlpath%3Ddesktop%252F%26branch%3Dbinder-environments
31 :class: new-window
32
33 .. only:: latex and not html
34
35 To immediately see DataLab in action, you have two options:
36
37 - Read or view our :ref:`Tutorials <tutorials>`,
38 - Try DataLab online, without installation, using our `Binder environment <https://mybinder.org/v2/gh/DataLab-Platform/DataLab/binder-environments?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FDataLab-Platform%252FDataLab%26urlpath%3Ddesktop%252F%26branch%3Dbinder-environments>`_.
39
40 .. figure:: images/DataLab-Overview.png
41 :class: dark-light
42
43 Signal and image visualization in DataLab
44
45
46 .. only:: html and not latex
47
48 .. grid:: 2 2 4 4
49 :gutter: 1 2 3 4
50
51 .. grid-item-card:: :octicon:`rocket;1em;sd-text-info` Getting started
52 :link: intro/index
53 :link-type: doc
54
55 Installation, tutorials, use cases...
56
57 .. grid-item-card:: :octicon:`tools;1em;sd-text-info` Features
58 :link: features/index
59 :link-type: doc
60
61 Detailed description
62
63 .. grid-item-card:: :octicon:`megaphone;1em;sd-text-info` Talks & Events
64 :link: outreach/index
65 :link-type: doc
66
67 Conference presentations
68
69 .. grid-item-card:: :octicon:`gear;1em;sd-text-info` Contributing
70 :link: contributing/index
71 :link-type: doc
72
73 Getting involved in the project
74
75 DataLab has been funded, chronologically, by the following stakeholders:
76
77 .. list-table::
78 :header-rows: 0
79
80 * - |cea_logo|
81 - `CEA <https://www.cea.fr>`_, the French Alternative Energies and Atomic Energy Commission, is the major investor in DataLab, and is the main contributor to the project.
82
83 * - |codra_logo|
84 - `CODRA`_, a software engineering and editor firm, has supported DataLab open-source journey since its inception (see `here <https://codra.net/en/offer/software-engineering/datalab/>`_).
85
86 * - |nlnet_logo|
87 - `NLnet Foundation <https://nlnet.nl>`_, as part of the NGI0 Commons Fund, backed by the European Commission, has funded the `redesign of DataLab's core architecture <https://nlnet.nl/project/DataLab/>`_.
88
89 .. |cea_logo| image:: images/logos/cea.svg
90 :width: 64px
91 :height: 64px
92 :target: https://www.cea.fr
93 :class: dark-light no-scaled-link
94
95 .. |codra_logo| image:: images/logos/codra.svg
96 :width: 64px
97 :height: 64px
98 :target: https://codra.net
99 :class: dark-light no-scaled-link
100
101 .. |nlnet_logo| image:: images/logos/nlnet.svg
102 :width: 64px
103 :height: 64px
104 :target: https://nlnet.nl
105 :class: dark-light no-scaled-link
106
107 .. figure:: _static/plotpy-stack-powered.png
108 :align: center
109 :width: 300 px
110 :class: dark-light no-scaled-link
111
112 DataLab is powered by `PlotPyStack <https://github.com/PlotPyStack>`_,
113 the scientific Python-Qt visualization and graphical user interface stack.
114
115 .. figure:: images/logos/Sigima-Banner.png
116 :align: center
117 :width: 200 px
118 :class: dark-light no-scaled-link
119
120 DataLab processing features are based on `Sigima <https://sigima.readthedocs.io/>`_,
121 the open-source signal and image processing library (part of the DataLab Platform).
122
123 .. toctree::
124 :maxdepth: 2
125 :hidden:
126
127 intro/index
128 features/index
129 contributing/index
130 release_notes/index
131
132 .. only:: html and not latex
133
134 .. toctree::
135 :hidden:
136
137 outreach/index
138
139 .. only:: latex and not html
140
141 .. note:: DataLab was created by `CODRA`_/`Pierre Raybaut`_ in 2023. It is
142 developed and maintained by DataLab Platform Developers.
143
144 .. note::
145
146 This project (DataLab Platform) should not be confused with the `datalab-org <https://datalab-org.io/>`_
147 project, which is a separate and unrelated initiative focused on materials science databases and computational tools.
148
149 .. rubric:: Footnotes
150
151 .. [#f1] DataLab processing primitives are mainly based on
152 `Sigima <https://sigima.readthedocs.io/>`_, `NumPy`_, `SciPy`_,
153 `scikit-image`_, `OpenCV`_ and `PyWavelets`_ libraries. DataLab visualization
154 capabilities are based on `PlotPyStack`_ toolkit, a set of Python libraries
155 for building scientific applications with Qt graphical user interfaces.
156 DataLab advanced and specialized processing features are based on `Sigima <https://sigima.readthedocs.io/>`_,
157 the open-source signal and image processing library (part of the DataLab Platform).
158
159 .. _NumPy: https://numpy.org/
160 .. _SciPy: https://www.scipy.org/
161 .. _scikit-image: https://scikit-image.org/
162 .. _OpenCV: https://opencv.org/
163 .. _PyWavelets: https://pywavelets.readthedocs.io/
164 .. _PlotPyStack: https://github.com/PlotPyStack
165 .. _CODRA: https://codra.net/
166 .. _Pierre Raybaut: https://github.com/PierreRaybaut/