Metadata-Version: 2.4
Name: tfields
Version: 0.6.0
Summary: Tensors, tensor fields, graphs, mesh manipulation, CAD and more on the basis of numpy.ndarrays. All objects keep track of their coordinate system. Symbolic math operations work for object manipulation.
Project-URL: Homepage, https://gitlab.mpcdf.mpg.de/dboe/tfields
Project-URL: Documentation, https://dboe.pages.mpcdf.de/tfields
Project-URL: Repository, https://gitlab.mpcdf.mpg.de/dboe/tfields
Project-URL: Issues, https://gitlab.mpcdf.mpg.de/dboe/tfields/-/issues/
Project-URL: Changelog, https://gitlab.mpcdf.mpg.de/dboe/tfields/-/blob/master/CHANGELOG.md
Author-email: Daniel Böckenhoff <dboe@ipp.mpg.de>
Maintainer-email: Daniel Böckenhoff <dboe@ipp.mpg.de>
License-Expression: MIT
License-File: AUTHORS.rst
License-File: LICENSE.rst
Keywords:  graphs, math, mesh, numpy, tensor-fields,tensors
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Requires-Dist: numpy>=1.20.0
Requires-Dist: pathlib; python_version < '3.10'
Requires-Dist: rna[plotting]>=0.10.0
Requires-Dist: scipy>=1.9.2
Requires-Dist: sortedcontainers
Requires-Dist: sympy>=1.13
Provides-Extra: full
Requires-Dist: numpy-stl; extra == 'full'
Provides-Extra: io
Requires-Dist: numpy-stl; extra == 'io'
Description-Content-Type: text/x-rst

tfields
=======

..
    [shields-start]

|pypi| |python| |license| |pipeline| |release| |coverage| |docs| |pre-commit|

.. |pypi| image:: https://img.shields.io/pypi/v/tfields.svg
    :target: https://pypi.org/project/tfields/
    :alt: Latest release on PyPI
.. |python| image:: https://img.shields.io/pypi/pyversions/tfields.svg
    :target: https://pypi.org/project/tfields/
    :alt: Supported python versions
.. |license| image:: https://img.shields.io/pypi/l/tfields.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/blob/master/LICENSE.rst
    :alt: MIT licensed
.. |pipeline| image:: https://gitlab.mpcdf.mpg.de/dboe/tfields/badges/master/pipeline.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/pipelines
    :alt: Pipeline status
.. |release| image:: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/badges/release.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/releases
    :alt: Latest release tag
.. |coverage| image:: https://gitlab.mpcdf.mpg.de/dboe/tfields/badges/master/coverage.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/commits/master
    :alt: Test coverage
.. |docs| image:: https://img.shields.io/website-up-down-green-red/https/dboe.pages.mpcdf.de/tfields.svg?label=docs
    :target: https://dboe.pages.mpcdf.de/tfields
    :alt: Documentation
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
    :target: https://github.com/pre-commit/pre-commit
    :alt: pre-commit

..
    [shields-end]

Overview
--------

..
    [overview-start]

Tensors, tensor fields, graphs, mesh manipulation, CAD and more on the basis of numpy.ndarrays. All objects keep track of their coordinate system. Symbolic math operations work for object manipulation.

..
    [overview-end]

Licensed under the ``MIT``

Resources
~~~~~~~~~

..
    [resources-start]

- Documentation: https://dboe.pages.mpcdf.de/tfields
- Source code: https://gitlab.mpcdf.mpg.de/dboe/tfields
- Bug reports: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/issues/
- Changelog: https://gitlab.mpcdf.mpg.de/dboe/tfields/-/blob/master/CHANGELOG.md

- PyPI: https://pypi.org/project/tfields/


..
    [resources-end]

Features
~~~~~~~~

..
    [features-start]

The following features should be highlighted:

* Tensors
* TensorFields
* TensorMaps with fields
* Mesh manipulation by graph theory

..
    [features-end]

Installation
~~~~~~~~~~~~

..
    [install-start]
    
.. code-block:: shell

    pip install tfields

..
    [install-end]

Usage
~~~~~

..
    [usage-start]

To use 'tfields' in a project use

.. code-block:: python

    import tfields

..
    [usage-end]

Review of alternative/supplementary APIs
----------------------------------------
* `sympy.diffgeom`: https://docs.sympy.org/latest/modules/diffgeom.html - Symbolic differential algebra implementation. It is not yet covering a broad variety of functionality and is not so well maintained.
* Units: You can find a comparison of modules handling units here: https://socialcompare.com/en/comparison/python-units-quantities-packages - astropy looks best to our understanding but sympy would integrated nicer without an additional package.
