Metadata-Version: 2.4
Name: stimkit
Version: 0.2.0
Summary: Canvas, renderer, and layout utilities for the Stim project.
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: h5py>=3.15.1
Requires-Dist: loguru>=0.7.3
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.3.5
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.3.3
Requires-Dist: polars>=1.36.1
Requires-Dist: pyarrow>=22.0.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: python-docx>=1.1.2
Requires-Dist: scipy>=1.16.3
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typer>=0.20.1
Description-Content-Type: text/markdown

# stimkit

`stimkit` is the Python package that powered the `stim_example` project. This repository now houses

- the reusable `stimkit` sources under a `src/stimkit` layout,
- the original `example` scripts that demonstrate the basic drawing workflows, and
- the minimal metadata needed to build and install the package.

## Getting started

1. Install the project in editable mode while you explore the examples:

   ```bash
   python -m pip install -e .
   ```

2. Run one of the example scripts to render the corresponding SVG output (each script writes to `example/output/`).

   ```bash
   python example/1_hello_world.py
   ```

3. Open the generated `example/output/1_hello_world.svg` in a browser or viewer to inspect the result.

## Repository layout

- `src/stimkit/`: package implementation (canvas, renderers, layout helpers, IO helpers, etc.).
- `example/`: scripts that consume `Stimkit` to draw progressively more complex scenes.
- `README.md`, `pyproject.toml`, `LICENSE`: standard package metadata.

## License

This project is distributed under the same terms as the `LICENSE` file already present in the repository.
