# Nabu
ESRF tomography processing software.
## Installation
To install the development version:
```bash
pip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git
```
To install the stable version:
```bash
pip install [--user] nabu
```
## Usage
Nabu can be used in several ways:
- As a Python library, by features like `Backprojector`, `FlatField`, etc
- As a standalone application with the command line interface
- From Tomwer ([https://gitlab.esrf.fr/tomotools/tomwer/](https://gitlab.esrf.fr/tomotools/tomwer/))
To get quickly started, launch:
```bash
nabu-config
```
Edit the generated configuration file (`nabu.conf`). Then:
```bash
nabu nabu.conf --slice 500-600
```
will reconstruct the slices 500 to 600, with processing steps depending on `nabu.conf` contents.
## Documentation
The documentation can be found on the silx.org page ([https://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).
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/)
## Running the tests
Once nabu is installed, running
```bash
nabu-test
```
will execute all the tests. You can also specify specific module(s) to test, for example:
```bash
nabu-test preproc misc
```
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.
## Nabu - what's in a name ?
Nabu was the Mesopotamian god of literacy, rational arts, scribes and wisdom.
Raw data
{
"_id": null,
"home_page": null,
"name": "nabu",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Pierre Paleo <pierre.paleo@esrf.fr>",
"keywords": "tomography, reconstruction, X-ray imaging, synchrotron radiation, High Performance Computing, Parallel geometry, Conebeam geometry, Helical geometry, Ring artefact correction, Geometric calibration",
"author": null,
"author_email": "Pierre Paleo <pierre.paleo@esrf.fr>, Henri Payno <henri.payno@esrf.fr>, Alessandro Mirone <mirone@esrf.fr>, J\u00e9r\u00f4me Lesaint <jerome.lesaint@esrf.fr>",
"download_url": "https://files.pythonhosted.org/packages/63/86/46e1f23aeb7df0d5acac1afa703f8020ec2df2dc68de63ed23a40a694a45/nabu-2025.1.0.tar.gz",
"platform": null,
"description": "# Nabu\n\nESRF tomography processing software.\n\n## Installation\n\nTo install the development version:\n\n```bash\npip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git\n```\nTo install the stable version:\n\n```bash\npip install [--user] nabu\n```\n\n## Usage\n\nNabu can be used in several ways:\n - As a Python library, by features like `Backprojector`, `FlatField`, etc\n - As a standalone application with the command line interface\n - From Tomwer ([https://gitlab.esrf.fr/tomotools/tomwer/](https://gitlab.esrf.fr/tomotools/tomwer/))\n\nTo get quickly started, launch:\n```bash\nnabu-config \n```\nEdit the generated configuration file (`nabu.conf`). Then:\n\n```bash\nnabu nabu.conf --slice 500-600\n```\n\nwill reconstruct the slices 500 to 600, with processing steps depending on `nabu.conf` contents.\n\n## Documentation\n\nThe documentation can be found on the silx.org page ([https://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).\n\nThe latest documentation built by continuous integration can be found here: [https://tomotools.gitlab-pages.esrf.fr/nabu/](https://tomotools.gitlab-pages.esrf.fr/nabu/)\n\n## Running the tests\n\nOnce nabu is installed, running\n\n```bash\nnabu-test\n```\nwill execute all the tests. You can also specify specific module(s) to test, for example:\n```bash\nnabu-test preproc misc\n```\nYou 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.\n\n\n\n## Nabu - what's in a name ?\n\nNabu was the Mesopotamian god of literacy, rational arts, scribes and wisdom.\n",
"bugtrack_url": null,
"license": null,
"summary": "Nabu - Tomography software",
"version": "2025.1.0",
"project_urls": {
"Changelog": "https://gitlab.esrf.fr/tomotools/nabu/-/blob/master/CHANGELOG.md",
"Documentation": "http://www.silx.org/pub/nabu/doc",
"Homepage": "https://gitlab.esrf.fr/tomotools/nabu",
"Repository": "https://gitlab.esrf.fr/tomotools/nabu/-/releases"
},
"split_keywords": [
"tomography",
" reconstruction",
" x-ray imaging",
" synchrotron radiation",
" high performance computing",
" parallel geometry",
" conebeam geometry",
" helical geometry",
" ring artefact correction",
" geometric calibration"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bc040c16ba2eb4f932c9be3bd957e20160c75190fdfc577fe7ea4d076a71fd5e",
"md5": "1a946fe1b67f06a2b7ea46bdd369f441",
"sha256": "fd0c20926a04973b17a20607272370513a2b18a1d9fe28b225549ba77d3f3068"
},
"downloads": -1,
"filename": "nabu-2025.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a946fe1b67f06a2b7ea46bdd369f441",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 665363,
"upload_time": "2025-07-22T11:42:12",
"upload_time_iso_8601": "2025-07-22T11:42:12.056868Z",
"url": "https://files.pythonhosted.org/packages/bc/04/0c16ba2eb4f932c9be3bd957e20160c75190fdfc577fe7ea4d076a71fd5e/nabu-2025.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "638646e1f23aeb7df0d5acac1afa703f8020ec2df2dc68de63ed23a40a694a45",
"md5": "7de2b8451ce73bcd1fd3f54b896a9222",
"sha256": "a06a646b37adc7dd2a524081f46f087fc3edbc6f5e91c5254945bc8f104a8ea3"
},
"downloads": -1,
"filename": "nabu-2025.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7de2b8451ce73bcd1fd3f54b896a9222",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 538548,
"upload_time": "2025-07-22T11:42:18",
"upload_time_iso_8601": "2025-07-22T11:42:18.279179Z",
"url": "https://files.pythonhosted.org/packages/63/86/46e1f23aeb7df0d5acac1afa703f8020ec2df2dc68de63ed23a40a694a45/nabu-2025.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 11:42:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nabu"
}