.. 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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.esrf.fr/tomotools/tomwer",
"name": "tomwer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "orange3 add-on, ewoks",
"author": "Henri Payno, Pierre Paleo, Pierre-Olivier Autran, J\u00e9r\u00f4me Lesaint, Alessandro Mirone",
"author_email": "henri.payno@esrf.fr, pierre.paleo@esrf.fr, pierre-olivier.autran@esrf.fr, jerome.lesaint@esrf.fr, mirone@esrf.fr",
"download_url": "https://files.pythonhosted.org/packages/5d/61/f8dd6b655547d2e95c44253ab437db8e989beefd3df24e2434383a7a9279/tomwer-1.4.6.tar.gz",
"platform": null,
"description": ".. image:: doc/img/tomwer.png\n :alt: Tomwer Logo\n :align: left\n :width: 400px\n\nIntroduction\n------------\n\n**Tomwer** provides tools to automate acquisition and reconstruction processes for tomography. The package includes:\n\n- A library to individually access each acquisition process.\n- Graphical User Interface (GUI) applications to control key processes such as reconstruction and data transfer, which can be executed as standalone applications.\n- An Orange add-on to help users define custom workflows (`Orange3 <http://orange.biolab.si>`_).\n\nTomwer relies on `Nabu <https://gitlab.esrf.fr/tomotools/nabu>`_ for tomographic reconstruction.\n\n**Note**: Currently, the software is only compatible with Linux.\n\nDocumentation\n-------------\n\nThe latest version of the documentation is available `here <https://tomotools.gitlab-pages.esrf.fr/tomwer/>`_.\n\nInstallation\n------------\n\nStep 1: Installing Tomwer\n'''''''''''''''''''''''''\n\nTo install Tomwer with all features:\n\n.. code-block:: bash\n\n pip install tomwer[full]\n\nAlternatively, you can install the latest development branch from the repository:\n\n.. code-block:: bash\n\n pip install git+https://gitlab.esrf.fr/tomotools/tomwer/#egg=tomwer[full]\n\n\nStep 2: (Optional) Update Orange-CANVAS-CORE and Orange-WIDGET-BASE\n''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''\n\nIf 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.\n\n.. code-block:: bash\n\n pip install git+https://github.com/payno/orange-canvas-core --no-deps --upgrade\n pip install git+https://github.com/payno/orange-widget-base --no-deps --upgrade\n\n\nLaunching Applications\n-----------------------\n\nAfter installation, Tomwer includes several applications. You can launch an application by running:\n\n.. code-block:: bash\n\n tomwer <appName> [options]\n\n- If you run `tomwer` without arguments, a manual page will be displayed.\n- For application-specific help, run:\n\n.. code-block:: bash\n\n tomwer <appName> --help\n\n\nTomwer Canvas - Orange Canvas\n-----------------------------\n\nYou can launch the Orange canvas to create workflows using the available building blocks:\n\n.. code-block:: bash\n\n tomwer canvas\n\n- Alternatively, you can use `orange-canvas`.\n- If you're using a virtual environment, remember to activate it:\n\n.. code-block:: bash\n\n source myvirtualenv/bin/activate\n\n\nBuilding Documentation\n-----------------------\n\nTo build the documentation:\n\n.. code-block:: bash\n\n sphinx-build doc build/html\n\nThe documentation will be generated in `doc/build/html`, and the entry point is `index.html`. To view the documentation in a browser:\n\n.. code-block:: bash\n\n firefox build/html/index.html\n\n**Note**: Building the documentation requires `sphinx` to be installed, which is not a hard dependency of Tomwer. If needed, install it separately.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\"tomography workflow tools\"",
"version": "1.4.6",
"project_urls": {
"Bug Tracker": "https://gitlab.esrf.fr/tomotools/tomwer/-/issues",
"Homepage": "https://gitlab.esrf.fr/tomotools/tomwer"
},
"split_keywords": [
"orange3 add-on",
" ewoks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a01dd2b46ac3f6fe60e92f44cfec5f2031b39b0f7b2273e3d52f7c97a44684b",
"md5": "f39d2abc040f51f8ac43c10a7d077cc1",
"sha256": "838bd94116704c1c410f03582fe8e3223dc5f47e9b744a792d0e434ea49866b5"
},
"downloads": -1,
"filename": "tomwer-1.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f39d2abc040f51f8ac43c10a7d077cc1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4387976,
"upload_time": "2025-01-23T09:34:33",
"upload_time_iso_8601": "2025-01-23T09:34:33.997722Z",
"url": "https://files.pythonhosted.org/packages/8a/01/dd2b46ac3f6fe60e92f44cfec5f2031b39b0f7b2273e3d52f7c97a44684b/tomwer-1.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d61f8dd6b655547d2e95c44253ab437db8e989beefd3df24e2434383a7a9279",
"md5": "b72a54b7b8425056310debc110d49307",
"sha256": "4639e8863e8048f80ffb8cb153e7dab45478b80d95316b566480b29022cf1fbc"
},
"downloads": -1,
"filename": "tomwer-1.4.6.tar.gz",
"has_sig": false,
"md5_digest": "b72a54b7b8425056310debc110d49307",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3958420,
"upload_time": "2025-01-23T09:34:37",
"upload_time_iso_8601": "2025-01-23T09:34:37.089502Z",
"url": "https://files.pythonhosted.org/packages/5d/61/f8dd6b655547d2e95c44253ab437db8e989beefd3df24e2434383a7a9279/tomwer-1.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 09:34:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tomwer"
}
JSON