Metadata-Version: 2.4
Name: telekinesis-tf
Version: 0.1.3
Summary: A frame transformation library for Python from Telekinesis. Provides tools for working with 3D coordinate frames, transformations, and visualizations.
Author-email: Telekinesis <support@telekinesis.ai>
Maintainer-email: Telekinesis <support@telekinesis.ai>
License-Expression: LicenseRef-Proprietary
Project-URL: Homepage, https://github.com/telekinesis-ai
Project-URL: Documentation, https://docs.telekinesis.ai/
Project-URL: Support, https://discord.gg/7NnQ3bQHqm
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <=3.12,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.26
Requires-Dist: scipy
Requires-Dist: rerun-sdk>=0.31
Requires-Dist: loguru>=0.5.0
Provides-Extra: dev
Requires-Dist: ruff==0.15.8; extra == "dev"
Requires-Dist: pylint==4.0.5; extra == "dev"
Dynamic: license-file

<div align="center">
  <p>
    <a align="center" href="" target="_blank">
      <img
        width="100%"
        src="https://telekinesis-public-assets.s3.us-east-1.amazonaws.com/Telekinesis+Banner.png"
      >
    </a>
  </p>

  <br>

  [Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples) | [Telekinesis Data](https://gitlab.com/telekinesis/telekinesis-data)
  <br>

[![PyPI version](https://img.shields.io/pypi/v/telekinesis-tf)](https://pypi.org/project/telekinesis-tf/)
[![License](https://img.shields.io/pypi/l/telekinesis-tf)](https://pypi.org/project/telekinesis-tf/)
[![Python versions](https://img.shields.io/pypi/pyversions/telekinesis-tf)](https://pypi.org/project/telekinesis-tf/)

</div>

<p align="center">
  <a href="https://github.com/telekinesis-ai">GitHub</a>
  &nbsp;•&nbsp;
  <a href="https://www.linkedin.com/company/telekinesis-ai/">LinkedIn</a>
  &nbsp;•&nbsp;
  <a href="https://x.com/telekinesis_ai">X</a>
  &nbsp;•&nbsp;
  <a href="https://discord.gg/7NnQ3bQHqm">Discord</a>
</p>


# Telekinesis TF

A Python library for working with coordinate frames, transformations, and visualization.
It includes:
- A `TransformTree` class for creating and managing transformation trees
- Utilities for converting between pose representations, including quaternions, Euler angles, and rotation vectors
- Visualization tools for frames using Rerun

**Telekinesis TF is currently in its early development phase (pre-1.0). There will be continuous minor version updates that may introduce new data models and improvements. To ensure compatibility and have the latest features, please always install or upgrade to the latest version of the package.**.


## Installation

1. Create an isolated environment to avoid dependency conflicts. We recommend installing `Miniconda` by following the instructions from [here](https://docs.conda.io/en/latest/miniconda.html#installing).
    ```bash
    conda create -n telekinesis-tf python=3.11
    ```
2. Activate the environment:
    ```bash
    conda activate telekinesis-tf
    ```
3. Install `tf` using `pip`:
  ```
  pip install telekinesis-tf
  ```

## Example
Run a sample Python script to quickly test your installation
```
from telekinesis.tf import tftree

tf_tree = tftree.TransformTree("world")
tf_tree.add("world", "new_frame", [0, 0, 1, 0, 0, 0], rot_type="deg")
tf_tree.visualize_rerun()
```

## Resources
- [Documentation](https://docs.telekinesis.ai/) coming soon!


## Support

For issues and questions:

- Create an [issue](https://github.com/telekinesis-ai/telekinesis-examples/issues) in the GitHub repository.
- Contact the Telekinesis development team at support@telekinesis.ai or on [Discord](https://discord.com/invite/7NnQ3bQHqm).


