Metadata-Version: 2.4
Name: magma_core
Version: 2.0.0b2
Summary: Core abstractions and protocols for MAGMA
Requires-Python: <3.13,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch<3,>=2.8
Requires-Dist: requests<3,>=2.34.2
Requires-Dist: PyYAML<7,>=6.0.3
Requires-Dist: pydantic<3,>=2.4
Requires-Dist: typing_extensions>=4.0
Provides-Extra: interface
Provides-Extra: simulation
Requires-Dist: mani_skill==3.0.1; extra == "simulation"
Requires-Dist: sapien==3.0.3; extra == "simulation"
Requires-Dist: numpy==1.26.4; extra == "simulation"
Requires-Dist: gymnasium==1.3.0; extra == "simulation"
Requires-Dist: transforms3d==0.4.2; extra == "simulation"
Provides-Extra: all
Requires-Dist: magma_core[simulation]; extra == "all"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# magma-core
MAGMA core is one Python package with two dependency zones. Version 2.0.0b1
is the first beta of v2. This beta supports Python 3.12; simulation installation
was checked on Linux x86_64. Broader Python/platform support is not yet validated.

## Description

magma_core contains protocol, base classes and utils used by different magma packages.

## Installation

### Pip

```bash
pip install "magma_core==2.0.0b1"              # Simulator-independent interface
pip install "magma_core[interface]==2.0.0b1"   # Alias for the default install
pip install "magma_core[simulation]==2.0.0b1"  # Includes simulation dependencies
```

For a local checkout, use `pip install -e .` or `pip install -e ".[all]"`.
Extras add dependencies; they do not change which Python modules are shipped.
The default installation includes Torch, requests, PyYAML, Pydantic, and
`typing_extensions`, but does not require ManiSkill, SAPIEN, or Gymnasium.

### Github

```bash
pip install "git+https://github.com/MAGMA-rob/magma-core.git@main"
```

Install a pinned release tag:

```bash
pip install "magma_core[simulation] @ git+https://github.com/MAGMA-rob/magma-core.git@v2.0.0b1"
```

---

If you spot any documentation errors, problem in the code. Please contact me at `l.bernat@sileane.com`
