nabu

Name	nabu JSON
Version	2024.2.2 JSON
	download
home_page	None
Summary	Nabu - Tomography software
upload_time	2024-12-19 08:11:17
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT License Copyright (c) 2020-2024 ESRF Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	tomography reconstruction x-ray imaging synchrotron radiation high performance computing parallel geometry conebeam geometry helical geometry ring artefact correction geometric calibration
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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.7",
    "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/08/8e/9b74715e82929a43eb89b03073c200ce0405b8770806a6fc2e2f160d3351/nabu-2024.2.2.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": "MIT License  Copyright (c) 2020-2024 ESRF  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Nabu - Tomography software",
    "version": "2024.2.2",
    "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": "",
            "digests": {
                "blake2b_256": "5725a6146e092421a91a02b949b8a1ca700e698ab69ea1edf7afc35051c20b64",
                "md5": "30fb862454f6089747874b03addc3c90",
                "sha256": "ffdb63c33e7f490a2a93418ff8190fb7c1754c6007ceed1da5e739a4dcc7cb2a"
            },
            "downloads": -1,
            "filename": "nabu-2024.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "30fb862454f6089747874b03addc3c90",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 625796,
            "upload_time": "2024-12-19T08:11:10",
            "upload_time_iso_8601": "2024-12-19T08:11:10.030360Z",
            "url": "https://files.pythonhosted.org/packages/57/25/a6146e092421a91a02b949b8a1ca700e698ab69ea1edf7afc35051c20b64/nabu-2024.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "088e9b74715e82929a43eb89b03073c200ce0405b8770806a6fc2e2f160d3351",
                "md5": "74c6784961fba345ab01a967159549c0",
                "sha256": "7ce1440af213ce21e2664cc2c3902656aefdae339e7bcbb266e3c1b43daf7eab"
            },
            "downloads": -1,
            "filename": "nabu-2024.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "74c6784961fba345ab01a967159549c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 501805,
            "upload_time": "2024-12-19T08:11:17",
            "upload_time_iso_8601": "2024-12-19T08:11:17.145667Z",
            "url": "https://files.pythonhosted.org/packages/08/8e/9b74715e82929a43eb89b03073c200ce0405b8770806a6fc2e2f160d3351/nabu-2024.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 08:11:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "nabu"
}