Metadata-Version: 2.3
Name: inksim
Version: 0.1.5
Summary: Interactive embroidery simulator
Author: Tony Karnigen
License: GNU GENERAL PUBLIC LICENSE
         Version 3, 29 June 2007
         
         Copyright (c) 2026 Tony Karnigen
         
         InkSim is free software: you can redistribute it and/or modify it under the
         terms of the GNU General Public License as published by the Free Software
         Foundation, either version 3 of the License, or (at your option) any later
         version.
         
         InkSim is distributed in the hope that it will be useful, but WITHOUT ANY
         WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
         A PARTICULAR PURPOSE. See the GNU General Public License for more details.
         
         The full text of the GNU General Public License is available at
         <https://www.gnu.org/licenses/>.
         
         SPDX-License-Identifier: GPL-3.0-or-later
Requires-Dist: wxpython==4.2.5
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: pystitch
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/karnigen/inksim
Project-URL: Repository, https://github.com/karnigen/inksim.git
Project-URL: Issues, https://github.com/karnigen/inksim/issues
Description-Content-Type: text/markdown

# InkSim

InkSim is a standalone interactive embroidery simulator and preview renderer.
It opens embroidery files, displays their stitch sequence, and lets the user
inspect or replay the design before production. It is implemented as a small
Python/wxPython/Numba application with its own standalone user interface.

<p align="center">
  <img src="https://raw.githubusercontent.com/karnigen/inksim/main/docs/assets/images/InkSim_colorful_small.png" alt="InkSim preview" width="350">
</p>

InkSim is experimental software provided for development and testing.

## Installation

Install the published PyPI package with `uv`:

```bash
uv tool install inksim
```

Then run it directly from your shell:

```bash
inksim design.pes
```

Linux users need a wxPython wheel matching their distribution. For example,
Ubuntu 24.04 users can install InkSim with:

```bash
uv tool install --find-links https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-24.04 inksim
```

See [installation and running](https://github.com/karnigen/inksim/blob/main/docs/installation.md) for other Linux
versions, `pip`/virtual-environment installation, and developer setup.

## Quick start

```bash
inksim
inksim design.pes
inksim design.pes --play
```

## Documentation

- [Project overview](https://github.com/karnigen/inksim/blob/main/docs/index.md)
- [Installation and running](https://github.com/karnigen/inksim/blob/main/docs/installation.md)
- [User guide](https://github.com/karnigen/inksim/blob/main/docs/user-guide.md)
- [Contributing](https://github.com/karnigen/inksim/blob/main/CONTRIBUTING.md)

## Background

I started working on embroidery tooling in 2013 with a small project called Orca.
It began as a C++/Qt experiment with graph algorithms for Inkscape on Linux and
later grew into a digitizer and a stitch viewer. An old recording of the viewer is here:

[Orca viewer demo](https://www.youtube.com/watch?v=VKle5ApsMnA)

InkSim is a new, standalone implementation of the same viewer idea, written from scratch in Python, wxPython and Numba and focused on quickly previewing embroidery files. It's a small viewer I was missing myself, so I kept it as a lightweight tool and I'm sharing it here in case it's useful for others in the Inkscape / Ink/Stitch community.

Thanks to the Ink/Stitch project and its community for keeping this space alive and inspiring.

## License

InkSim is released under the [GNU General Public License v3 or later](https://github.com/karnigen/inksim/blob/main/LICENSE).
