Metadata-Version: 2.4
Name: gstaichi
Version: 3.0.0b1
Summary: The GsTaichi Programming Language
Maintainer: GsTaichi developers
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/Genesis-Embedded-AI/gstaichi
Keywords: graphics,simulation
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Games/Entertainment :: Simulation
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
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.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.0
Requires-Dist: colorama
Requires-Dist: dill
Requires-Dist: pydantic>=2.0.0
Requires-Dist: rich>=1.0.0
Requires-Dist: setuptools>=77.0.0
Requires-Dist: cffi>=1.16.0
Dynamic: license-file

# GsTaichi

[GsTaichi](https://github.com/Genesis-Embodied-AI/gstaichi) was forked in June 2025. This repository (or gstaichi) is now a fully independent project with no intention of maintaining backward compatibility with the original taichi. Whilst the repo largely resembles upstream for now, we have made the following changes:
- revamped continuous integration, to run using recent python versions (up to 3.13), recent mac os x versions (up to 15), and to run reliably (at least 80% of runs with correct code succeed)
- added dataclasses.dataclass structs:
    - work with both ndarrays and fields (cf ti.struct (field only), ti.dataclass (field only), ti.data_oriented (field only), argpack (ndarray only))
    - can be passed into child `ti.func`tions (cf argpack)
    - does not affect kernel runtime speed (kernels see only the underlying arrays, no indirection is added within the kernel layer)
- removed GUI/GGUI, C-API, AOT, DX11, DX12, IOS, Android, OpenGL, GLES

Planned features:
- reduce warm cache launch latency
- (maybe) add launch args caching, to reduce launch latency
- make dataclasses.dataclass nestable

Planned pruning:
- remove argpack
- remove ti CLI
- remove support for NVidia GPUs earlier than sm_60/Pascal

# What is gstaichi?

GsTaichi is a high performance multi-platform compiler, targeted at physics simulations. It compiles Python code into parallelizable kernels that can run on:
- NVidia GPUs, using CUDA
- Vulkan-compatible GPUs, using SPIR-V
- Mac Metal GPUs
- x86 and arm64 CPUs

GsTaichi supports automatic differentiation. GsTaichi lets you build fully fused GPU kernels, using Python.

[Genesis simulator](https://genesis-world.readthedocs.io/en/latest/)'s best-in-class performance can be largely attributed to Taichi, its underlying GPU acceleration framework for Python. Given how critical is this component, we decided to fork Taichi and build our own very framework from there, so that from now on, we are free to drive its development in the direction that best supports the continuous improvement of Genesis simulator.

# Installation
## Prerequisites
- Python 3.10-3.13
- Mac OS 14, 15, Windows, or Ubuntu 22.04-24.04 or compatible

## Procedure
```
pip install gstaichi
```

(For how to build from source, see our CI build scripts, e.g. [linux build scripts](.github/workflows/scripts_new/linux_x86/) )

# Documentation

- [docs](https://genesis-embodied-ai.github.io/gstaichi/user_guide/index.html)
- [API reference](https://genesis-embodied-ai.github.io/gstaichi/autoapi/index.html)

# Something is broken!

- [Create an issue](https://github.com/Genesis-Embodied-AI/gstaichi/issues/new/choose)

# Acknowledgements

- The original [Taichi](https://github.com/taichi-dev/taichi) was developed with love by many contributors over many years. For the full list of contributors and credits, see [Original taichi contributors](https://github.com/taichi-dev/taichi?tab=readme-ov-file#contributing)
