Metadata-Version: 2.4
Name: mathrobo
Version: 0.0.1
Summary: basic mathematical library for robotics reserach
Project-URL: Homepage, https://github.com/MathRobotics/MathRobo
Author-email: taiki-ishigaki <taiki000ishigaki@gmail.com>
License: MIT License
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: jax>=0.4.30
Requires-Dist: numpy>=2.0.2
Requires-Dist: pytest>=8.4.2
Requires-Dist: scipy>=1.13.1
Requires-Dist: sympy>=1.14.0
Description-Content-Type: text/markdown

# Mathrobo

Mathrobo is a lightweight library designed to support mathematical optimization and computations related to robotics.

## Installation

### Clone the repository

```bash
git clone https://github.com/MathRobotics/MathRobo.git
cd MathRobo
```

### Install dependencies with uv

Sync the environment from `pyproject.toml` and `uv.lock`:

```bash
uv sync
```

### Install the package in editable mode

```bash
uv pip install -e .
```

## Examples
Refer to the examples in the `examples` folder, where you can find Jupyter notebooks and scripts demonstrating various use cases of the library.

## Running Tests

Run the test suite with uv:

```bash
uv run pytest
```

## Contributing
Contributions are welcome! Feel free to report issues, suggest features, or submit pull requests.
