[](https://app.travis-ci.com/ToFuProject/tofu)
[](https://travis-ci.org/ToFuProject/tofu)
[](https://anaconda.org/conda-forge/tofu)
[](https://anaconda.org/conda-forge/tofu)
[](https://anaconda.org/conda-forge/tofu)
[](https://anaconda.org/conda-forge/tofu)
[](https://github.com/conda-forge/tofu/blob/master/LICENSE.txt)
[](https://anaconda.org/conda-forge/tofu)
[](https://codecov.io/gh/ToFuProject/tofu)
[](https://badge.fury.io/py/tofu)
[](https://gitter.im/ToFuProject/community)
[](https://www.plasmapy.org/affiliates/)
[](https://www.plasmapy.org/affiliates/)
[](https://github.com/ToFuProject/tofu)
tofu
====
**tofu** stands for **To**mography for **Fu**sion, it is an IMAS-compatible open-source machine-independent python library.
tofu tries to take an active part in the plasma community open-source python environment, like [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy), with which some degree of interoperability is being implemented.
It aims at providing the **fusion** and **plasma** community with an object-oriented, transparent and documented tool for designing **tomography diagnostics**, computing **synthetic signal** (direct problem) as well as **tomographic inversions** (inverse problem). It gives access to a full 3D description of the diagnostic geometry, thus reducing the impact of geometrical approximations on the direct and, most importantly, on the inverse problem.
**tofu** is relevant for all diagnostics integrating, in a finitie field of view or along a set of lines of sight, a quantity (scalar or vector) for which the plasma can be considered transparent (e.g.: light in the visible, UV, soft and hard X-ray ranges, or electron density for interferometers).
**tofu** is **command-line oriented**, for maximum flexibility and scriptability.
The absence of a GUI is compensated by built-in one-liners for interactive plots.
It has a sphinx-generated [documentation](https://tofuproject.github.io/tofu/index.html), and the code itself is hosted on [GitHub](https://github.com/ToFuProject/tofu).
## Examples Gallery
Here are some examples of what **tofu** can do
#### Built-in one-liners for interactive camera geometry visualization
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_touch.png" width="600" alt="Built-in one-liners for interactive camera geometry visualization"/>
</p>
#### ...both for 1D and 2D cameras, including the basics for multiple reflections handling
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS2D_touch_refelect.png" width="600" alt="...both for 1D and 2D cameras, including the basics for multiple reflections handling"/>
</p>
#### Built-in plotting of sinograms
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_sino.png" width="600" alt="Built-in plotting of sinograms"/>
</p>
#### Basic magnetic field line tracing
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/MagfieldLines.png" width="600" alt="Basic magnetic field line tracing"/>
</p>
#### Multiple 1d profiles interactive plotting
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png" width="600" alt="Multiple 1d profiles interactive plotting"/>
</p>
#### Built-in basic data treatment and interactive plotting: svd and spectrograms
<p align="center">
<img align="middle" src="https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png" width="600" alt="Built-in basic data treatment and interactive plotting: svd and spectrograms"/>
</p>
**tofu** provides the user with a series of python classes for creating, handling and visualizing a diagnostic geometry, meshes and basis functions,
geometry matrices, pre-treating experimental data and computing tomographic inversions.
Each one of these main tasks is accomplished by a dedicated module in the larger tofu package.
The geometry module is sufficient for diagnostic designing and for a synthetic diagnostic approach (i.e.: computing the integrated signal from a simulated 2D or 3D emissivity).
This geometry module allows in particular:
* To handle linear and toroidal vaccum vessels
* To define apertures and detectors as planar polygons of arbitrary shapes
* To automatically compute the full Volume of Sight (VOS) in 3D of each {detector+aperture(s)} set
* To discretise the VOS for a numerical 3D integration of a simulated emissivity in order to compute the associated signal
It is in this geometrical sense that tofu enables a synthetic diagnostic approach, it does not provide the tools for simulating the emissivity itself (that should be an input, provided by another code).
## IMAS-compatibility
IMAS is a standardized data structure, it comes as an extra layer on the database of any Tokamak to provide a machine-independent way of accessing scientific data.
tofu has built-in advanced classes for handling the interface with IMAS, hold in the imas2tofu sub-package.
It pre-supposes, of course, that IMAS is installed and operational next to your python install, but tofu does not require IMAS to run in general.
If IMAS is not available, tofu will simply display a warning stating that the imas2tofu sub-package is not usable.
tofu can thus easily load and handle multiple IDSs (IMAS data structure units) and provide command-line tools for exporting IMAS data to other general tofu classes (e.g.: Cameras, Plasma2D...) and for interactive plotting.
All tofu objects have methods to facailitate in-python-console introspection, the ``__repr__`` method is overloaded to display relevant information, an dthis is widely used to explore the data loaded from IMAS.
Do you want to use **tofu** on IMAS and don't know where to start?
[See our documetation.](https://tofuproject.github.io/tofu/installation.html#using-tofu-on-a-iter-cluster)
----
## Installing tofu
**From source** (compiled on your system using pip, all platforms)
``` pip install tofu ```
**From pre-compiled binaries** (using conda, all platforms)
``` conda install -c conda-forge tofu ```
**For Developers and other platforms**
Clone the git repository from github
[See our documentation.](https://tofuproject.github.io/tofu/installation.html)
## Licensing
It is distributed under the MIT license and aims at providing the fusion
community with a transparent and modular tool for creating / designing
diagnostics and using them for synthetic diagnostic (direct problem)
and tomography (inverse problem).
## History
It was first created at the Max-Planck Institute for Plasma Physics (IPP)
in Garching, Germany, by Didier Vezinet, and is now maintained, debugged
and updated by a team of contributors.
-----
**Warning**
This Pypi package focuses on tomography for fusion research.
It uses the same name as a previous package dedicated to a testing framework
coupling fixtures and tests loosely, now renamed **reahl-tofu** and developped
by Iwan Vosloo since 2006. If you ended up here looking for a web-oriented
library, you should probably redirect to the more recent
[**reahl-tofu**](https://pypi.python.org/pypi/reahl-tofu) page.
Raw data
{
"_id": null,
"home_page": "https://github.com/ToFuProject/tofu",
"name": "tofu",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "tomography geometry 3D inversion synthetic fusion",
"author": "Didier VEZINET and Laura MENDOZA",
"author_email": "didier.vezinet@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/fc/f2d7b38b87835cd28e00a44ee516dc7046c65509321e987d847ea330d3fd/tofu-1.7.7.tar.gz",
"platform": null,
"description": "[](https://app.travis-ci.com/ToFuProject/tofu)\n[](https://travis-ci.org/ToFuProject/tofu)\n[](https://anaconda.org/conda-forge/tofu)\n[](https://anaconda.org/conda-forge/tofu)\n[](https://anaconda.org/conda-forge/tofu)\n[](https://anaconda.org/conda-forge/tofu)\n[](https://github.com/conda-forge/tofu/blob/master/LICENSE.txt)\n[](https://anaconda.org/conda-forge/tofu)\n[](https://codecov.io/gh/ToFuProject/tofu)\n[](https://badge.fury.io/py/tofu)\n[](https://gitter.im/ToFuProject/community)\n[](https://www.plasmapy.org/affiliates/)\n[](https://www.plasmapy.org/affiliates/)\n[](https://github.com/ToFuProject/tofu)\n\n\n\n\ntofu\n====\n\n**tofu** stands for **To**mography for **Fu**sion, it is an IMAS-compatible open-source machine-independent python library.\n\ntofu tries to take an active part in the plasma community open-source python environment, like [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy), with which some degree of interoperability is being implemented.\n\nIt aims at providing the **fusion** and **plasma** community with an object-oriented, transparent and documented tool for designing **tomography diagnostics**, computing **synthetic signal** (direct problem) as well as **tomographic inversions** (inverse problem). It gives access to a full 3D description of the diagnostic geometry, thus reducing the impact of geometrical approximations on the direct and, most importantly, on the inverse problem.\n\n**tofu** is relevant for all diagnostics integrating, in a finitie field of view or along a set of lines of sight, a quantity (scalar or vector) for which the plasma can be considered transparent (e.g.: light in the visible, UV, soft and hard X-ray ranges, or electron density for interferometers).\n\n**tofu** is **command-line oriented**, for maximum flexibility and scriptability.\nThe absence of a GUI is compensated by built-in one-liners for interactive plots.\n\n\nIt has a sphinx-generated [documentation](https://tofuproject.github.io/tofu/index.html), and the code itself is hosted on [GitHub](https://github.com/ToFuProject/tofu).\n\n\n\n## Examples Gallery\n\nHere are some examples of what **tofu** can do\n\n#### Built-in one-liners for interactive camera geometry visualization\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_touch.png\" width=\"600\" alt=\"Built-in one-liners for interactive camera geometry visualization\"/>\n</p>\n\n#### ...both for 1D and 2D cameras, including the basics for multiple reflections handling\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS2D_touch_refelect.png\" width=\"600\" alt=\"...both for 1D and 2D cameras, including the basics for multiple reflections handling\"/>\n</p>\n\n#### Built-in plotting of sinograms\n\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/CamLOS1D_sino.png\" width=\"600\" alt=\"Built-in plotting of sinograms\"/>\n</p>\n\n#### Basic magnetic field line tracing\n\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/MagfieldLines.png\" width=\"600\" alt=\"Basic magnetic field line tracing\"/>\n</p>\n\n\n#### Multiple 1d profiles interactive plotting\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png\" width=\"600\" alt=\"Multiple 1d profiles interactive plotting\"/>\n</p>\n\n#### Built-in basic data treatment and interactive plotting: svd and spectrograms\n<p align=\"center\">\n<img align=\"middle\" src=\"https://github.com/ToFuProject/tofu/blob/master/README_figures/Plasma2D_1dneTe.png\" width=\"600\" alt=\"Built-in basic data treatment and interactive plotting: svd and spectrograms\"/>\n</p>\n\n\n\n**tofu** provides the user with a series of python classes for creating, handling and visualizing a diagnostic geometry, meshes and basis functions, \ngeometry matrices, pre-treating experimental data and computing tomographic inversions.\n\nEach one of these main tasks is accomplished by a dedicated module in the larger tofu package.\n\nThe geometry module is sufficient for diagnostic designing and for a synthetic diagnostic approach (i.e.: computing the integrated signal from a simulated 2D or 3D emissivity).\nThis geometry module allows in particular:\n\n* To handle linear and toroidal vaccum vessels\n* To define apertures and detectors as planar polygons of arbitrary shapes\n* To automatically compute the full Volume of Sight (VOS) in 3D of each {detector+aperture(s)} set\n* To discretise the VOS for a numerical 3D integration of a simulated emissivity in order to compute the associated signal\n\nIt is in this geometrical sense that tofu enables a synthetic diagnostic approach, it does not provide the tools for simulating the emissivity itself (that should be an input, provided by another code).\n\n\n## IMAS-compatibility\n\n\nIMAS is a standardized data structure, it comes as an extra layer on the database of any Tokamak to provide a machine-independent way of accessing scientific data.\ntofu has built-in advanced classes for handling the interface with IMAS, hold in the imas2tofu sub-package.\nIt pre-supposes, of course, that IMAS is installed and operational next to your python install, but tofu does not require IMAS to run in general.\nIf IMAS is not available, tofu will simply display a warning stating that the imas2tofu sub-package is not usable.\n\ntofu can thus easily load and handle multiple IDSs (IMAS data structure units) and provide command-line tools for exporting IMAS data to other general tofu classes (e.g.: Cameras, Plasma2D...) and for interactive plotting.\nAll tofu objects have methods to facailitate in-python-console introspection, the ``__repr__`` method is overloaded to display relevant information, an dthis is widely used to explore the data loaded from IMAS.\n\nDo you want to use **tofu** on IMAS and don't know where to start?\n[See our documetation.](https://tofuproject.github.io/tofu/installation.html#using-tofu-on-a-iter-cluster)\n\n----\n\n\n## Installing tofu\n\n**From source** (compiled on your system using pip, all platforms)\n\n ``` pip install tofu ```\n\n**From pre-compiled binaries** (using conda, all platforms)\n\n ``` conda install -c conda-forge tofu ```\n\n**For Developers and other platforms**\n\nClone the git repository from github\n[See our documentation.](https://tofuproject.github.io/tofu/installation.html)\n\n\n## Licensing\n\nIt is distributed under the MIT license and aims at providing the fusion\ncommunity with a transparent and modular tool for creating / designing\ndiagnostics and using them for synthetic diagnostic (direct problem)\nand tomography (inverse problem).\n\n## History\n\nIt was first created at the Max-Planck Institute for Plasma Physics (IPP)\nin Garching, Germany, by Didier Vezinet, and is now maintained, debugged\nand updated by a team of contributors.\n\n\n-----\n\n**Warning**\nThis Pypi package focuses on tomography for fusion research.\nIt uses the same name as a previous package dedicated to a testing framework\ncoupling fixtures and tests loosely, now renamed **reahl-tofu** and developped\nby Iwan Vosloo since 2006. If you ended up here looking for a web-oriented\nlibrary, you should probably redirect to the more recent\n[**reahl-tofu**](https://pypi.python.org/pypi/reahl-tofu) page.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for Tomography for Fusion",
"version": "1.7.7",
"project_urls": {
"Homepage": "https://github.com/ToFuProject/tofu"
},
"split_keywords": [
"tomography",
"geometry",
"3d",
"inversion",
"synthetic",
"fusion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38fcf2d7b38b87835cd28e00a44ee516dc7046c65509321e987d847ea330d3fd",
"md5": "5efceb56c12db37199524bb7f215cda2",
"sha256": "31a89dc5b2d70fb20e89dc360732ac255b310f5071373266f4ce837470dc7c11"
},
"downloads": -1,
"filename": "tofu-1.7.7.tar.gz",
"has_sig": false,
"md5_digest": "5efceb56c12db37199524bb7f215cda2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4603367,
"upload_time": "2024-02-27T17:24:17",
"upload_time_iso_8601": "2024-02-27T17:24:17.355032Z",
"url": "https://files.pythonhosted.org/packages/38/fc/f2d7b38b87835cd28e00a44ee516dc7046c65509321e987d847ea330d3fd/tofu-1.7.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 17:24:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ToFuProject",
"github_project": "tofu",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "tofu"
}
JSON
