1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
Metadata-Version: 2.4
Name: tomwer
Version: 1.6.7
Summary: Tomography workflow tools
Author-email: Henri Payno <henri.payno@esrf.fr>, Pierre Paleo <pierre.paleo@esrf.fr>, Pierre-Olivier Autran <pierre-olivier.autran@esrf.fr>, Jérôme Lesaint <jerome.lesaint@esrf.fr>, Alessandro Mirone <mirone@esrf.fr>
License: MIT
Project-URL: Homepage, https://gitlab.esrf.fr/tomotools/tomwer
Project-URL: Documentation, https://tomotools.gitlab-pages.esrf.fr/tomwer/
Project-URL: Repository, https://gitlab.esrf.fr/tomotools/tomwer
Project-URL: Issues, https://gitlab.esrf.fr/tomotools/tomwer/-/issues
Project-URL: Changelog, https://gitlab.esrf.fr/tomotools/tomwer/-/blob/main/CHANGELOG.rst?ref_type=heads
Keywords: orange3 add-on,ewoks
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Environment :: X11 Applications :: Qt
Classifier: Operating System :: POSIX
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: setuptools
Requires-Dist: psutil
Requires-Dist: silx[full]>=2.1.1
Requires-Dist: tomoscan>=2.2.0a6
Requires-Dist: nxtomo>2.0.0dev2
Requires-Dist: nxtomomill>=2.0.0dev0
Requires-Dist: processview>=1.5.0
Requires-Dist: ewoks>=0.1.1
Requires-Dist: ewokscore<2.0,>=1.5
Requires-Dist: sluurp>=0.4.1
Requires-Dist: packaging
Requires-Dist: pint
Requires-Dist: tqdm
Requires-Dist: eval_type_backport; python_version < "3.10"
Provides-Extra: full-base
Requires-Dist: orange-canvas-core; extra == "full-base"
Requires-Dist: orange-widget-base; extra == "full-base"
Requires-Dist: ewoks[orange]>=0.1.1; extra == "full-base"
Requires-Dist: ewoksorange<2.0,>=0.7.0rc0; extra == "full-base"
Requires-Dist: fabio; extra == "full-base"
Requires-Dist: h5py>=3; extra == "full-base"
Requires-Dist: lxml; extra == "full-base"
Requires-Dist: werkzeug; extra == "full-base"
Requires-Dist: json-rpc; extra == "full-base"
Requires-Dist: scipy; extra == "full-base"
Requires-Dist: Pillow; extra == "full-base"
Requires-Dist: resource; extra == "full-base"
Requires-Dist: tifffile; extra == "full-base"
Requires-Dist: hdf5plugin; extra == "full-base"
Requires-Dist: pyicat_plus; extra == "full-base"
Requires-Dist: ewoksnotify[full]<0.2; extra == "full-base"
Requires-Dist: pyicat_plus; extra == "full-base"
Requires-Dist: rsyncmanager; extra == "full-base"
Requires-Dist: blissdata; extra == "full-base"
Provides-Extra: full-no-cuda
Requires-Dist: tomwer[full_base]; extra == "full-no-cuda"
Requires-Dist: nabu>=2024.2.0; extra == "full-no-cuda"
Provides-Extra: full
Requires-Dist: tomwer[full_base]; extra == "full"
Requires-Dist: nabu[full]>=2024.2.0; extra == "full"
Requires-Dist: pycuda<2024.1.1; extra == "full"
Requires-Dist: scikit-cuda; extra == "full"
Provides-Extra: doc
Requires-Dist: tomwer[full_no_cuda]; extra == "doc"
Requires-Dist: Sphinx>=4.0.0; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: pandoc; extra == "doc"
Requires-Dist: jupyterlab; extra == "doc"
Requires-Dist: pydata_sphinx_theme; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: sphinxcontrib-programoutput; extra == "doc"
Requires-Dist: sphinxcontrib-youtube; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Provides-Extra: dev-spec
Requires-Dist: black; extra == "dev-spec"
Requires-Dist: flake8; extra == "dev-spec"
Requires-Dist: timeout-decorator; extra == "dev-spec"
Requires-Dist: pyopencl; extra == "dev-spec"
Provides-Extra: dev
Requires-Dist: tomwer[full]; extra == "dev"
Requires-Dist: tomwer[dev_spec]; extra == "dev"
Provides-Extra: dev-no-cuda
Requires-Dist: tomwer[full_no_cuda]; extra == "dev-no-cuda"
Requires-Dist: tomwer[dev_spec]; extra == "dev-no-cuda"
Provides-Extra: test
Requires-Dist: tomwer[full_no_cuda]; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: tomoscan[test]>=2.2.0a6; extra == "test"
Dynamic: license-file
.. image:: doc/img/tomwer.png
:alt: Tomwer Logo
:align: left
:width: 400px
Introduction
------------
**Tomwer** provides tools to automate acquisition and reconstruction processes for tomography. The package includes:
- A library to individually access each acquisition process.
- Graphical User Interface (GUI) applications to control key processes such as reconstruction and data transfer, which can be executed as standalone applications.
- An Orange add-on to help users define custom workflows (`Orange3 <http://orange.biolab.si>`_).
Tomwer relies on `Nabu <https://gitlab.esrf.fr/tomotools/nabu>`_ for tomographic reconstruction.
**Note**: Currently, the software is only compatible with Linux.
Documentation
-------------
The latest version of the documentation is available `here <https://tomotools.gitlab-pages.esrf.fr/tomwer/>`_.
Installation
------------
Step 1: Installing Tomwer
'''''''''''''''''''''''''
To install Tomwer with all features:
.. code-block:: bash
pip install tomwer[full]
Alternatively, you can install the latest development branch from the repository:
.. code-block:: bash
pip install git+https://gitlab.esrf.fr/tomotools/tomwer/#egg=tomwer[full]
Step 2: (Optional) Update Orange-CANVAS-CORE and Orange-WIDGET-BASE
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
If you need access to additional 'processing' wheels and 'reprocess action,' you may want to update these Orange forks. This is optional, as the project works with the native Orange libraries.
.. code-block:: bash
pip install git+https://github.com/payno/orange-canvas-core --no-deps --upgrade
pip install git+https://github.com/payno/orange-widget-base --no-deps --upgrade
Launching Applications
-----------------------
After installation, Tomwer includes several applications. You can launch an application by running:
.. code-block:: bash
tomwer <appName> [options]
- If you run `tomwer` without arguments, a manual page will be displayed.
- For application-specific help, run:
.. code-block:: bash
tomwer <appName> --help
Tomwer Canvas - Orange Canvas
-----------------------------
You can launch the Orange canvas to create workflows using the available building blocks:
.. code-block:: bash
tomwer canvas
- Alternatively, you can use `orange-canvas`.
- If you're using a virtual environment, remember to activate it:
.. code-block:: bash
source myvirtualenv/bin/activate
Building Documentation
-----------------------
To build the documentation:
.. code-block:: bash
sphinx-build doc build/html
The documentation will be generated in `doc/build/html`, and the entry point is `index.html`. To view the documentation in a browser:
.. code-block:: bash
firefox build/html/index.html
**Note**: Building the documentation requires `sphinx` to be installed, which is not a hard dependency of Tomwer. If needed, install it separately.
|
