Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: nabu
3 Version: 2025.2.4
4 Summary: Nabu - Tomography software
5 Author-email: Pierre Paleo <[email protected]>, Henri Payno <[email protected]>, Alessandro Mirone <[email protected]>, Jérôme Lesaint <[email protected]>
6 Maintainer-email: Pierre Paleo <[email protected]>
7 License-Expression: MIT
8 Project-URL: Homepage, https://gitlab.esrf.fr/tomotools/nabu
9 Project-URL: Documentation, http://www.silx.org/pub/nabu/doc
10 Project-URL: Repository, https://gitlab.esrf.fr/tomotools/nabu/-/releases
11 Project-URL: Changelog, https://gitlab.esrf.fr/tomotools/nabu/-/blob/master/CHANGELOG.md
12 Keywords: tomography,reconstruction,X-ray imaging,synchrotron radiation,High Performance Computing,Parallel geometry,Conebeam geometry,Helical geometry,Ring artefact correction,Geometric calibration
13 Classifier: Development Status :: 5 - Production/Stable
14 Classifier: Intended Audience :: Developers
15 Classifier: Intended Audience :: Science/Research
16 Classifier: Programming Language :: Python :: 3
17 Classifier: Programming Language :: Python :: 3.10
18 Classifier: Programming Language :: Python :: 3.11
19 Classifier: Programming Language :: Python :: 3.12
20 Classifier: Programming Language :: Python :: 3.13
21 Classifier: Environment :: Console
22 Classifier: Operating System :: Unix
23 Classifier: Operating System :: MacOS :: MacOS X
24 Classifier: Operating System :: POSIX
25 Classifier: Topic :: Scientific/Engineering :: Physics
26 Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
27 Requires-Python: >=3.10
28 Description-Content-Type: text/markdown
29 License-File: LICENSE
30 Requires-Dist: numpy>1.9.0
31 Requires-Dist: scipy
32 Requires-Dist: h5py>=3.0
33 Requires-Dist: silx>=0.15.0
34 Requires-Dist: tomoscan>=2.3.0
35 Requires-Dist: psutil
36 Requires-Dist: pytest
37 Requires-Dist: tifffile
38 Requires-Dist: tqdm
39 Provides-Extra: full
40 Requires-Dist: scikit-image; extra == "full"
41 Requires-Dist: PyWavelets; extra == "full"
42 Requires-Dist: glymur; extra == "full"
43 Requires-Dist: pycudwt; extra == "full"
44 Requires-Dist: sluurp>=0.3; extra == "full"
45 Requires-Dist: pyvkfft; extra == "full"
46 Provides-Extra: full-nocuda
47 Requires-Dist: scikit-image; extra == "full-nocuda"
48 Requires-Dist: PyWavelets; extra == "full-nocuda"
49 Requires-Dist: glymur; extra == "full-nocuda"
50 Requires-Dist: sluurp>=0.3; extra == "full-nocuda"
51 Requires-Dist: pyvkfft; extra == "full-nocuda"
52 Provides-Extra: doc
53 Requires-Dist: mkdocs; extra == "doc"
54 Requires-Dist: mkdocs-material; extra == "doc"
55 Requires-Dist: mkdocs-material-extensions; extra == "doc"
56 Requires-Dist: mkdocs-gen-files; extra == "doc"
57 Requires-Dist: mkdocs-markdownextradata-plugin; extra == "doc"
58 Requires-Dist: mkdocs-pagetree-plugin; extra == "doc"
59 Requires-Dist: mkapi; extra == "doc"
60 Requires-Dist: mkdocs-jupyter; extra == "doc"
61 Requires-Dist: nbconvert; extra == "doc"
62 Requires-Dist: markdown-exec; extra == "doc"
63 Dynamic: license-file
64
65 # Nabu
66
67 ESRF tomography processing software.
68
69 ## Installation
70
71 To install the development version:
72
73 ```bash
74 pip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git
75 ```
76 To install the stable version:
77
78 ```bash
79 pip install [--user] nabu
80 ```
81
82 ## Usage
83
84 Nabu can be used in several ways:
85 - As a Python library, by features like `Backprojector`, `FlatField`, etc
86 - As a standalone application with the command line interface
87 - From Tomwer ([https://gitlab.esrf.fr/tomotools/tomwer/](https://gitlab.esrf.fr/tomotools/tomwer/))
88
89 To get quickly started, launch:
90 ```bash
91 nabu-config
92 ```
93 Edit the generated configuration file (`nabu.conf`). Then:
94
95 ```bash
96 nabu nabu.conf --slice 500-600
97 ```
98
99 will reconstruct the slices 500 to 600, with processing steps depending on `nabu.conf` contents.
100
101 ## Documentation
102
103 The documentation can be found on the silx.org page ([https://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).
104
105 The latest documentation built by continuous integration can be found here: [https://tomotools.gitlab-pages.esrf.fr/nabu/](https://tomotools.gitlab-pages.esrf.fr/nabu/)
106
107 ## Running the tests
108
109 Once nabu is installed, running
110
111 ```bash
112 nabu-test
113 ```
114 will execute all the tests. You can also specify specific module(s) to test, for example:
115 ```bash
116 nabu-test preproc misc
117 ```
118 You can also provide more `pytest` options, for example increase verbosity with `-v`, exit at the first fail with `-x`, etc. Use `nabu-test --help` for displaying the complete options list.
119
120
121
122 ## Nabu - what's in a name ?
123
124 Nabu was the Mesopotamian god of literacy, rational arts, scribes and wisdom.