Skip to main content

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/PySide6/Numba application with its own standalone user interface.

InkSim preview

InkSim is experimental software provided for development and testing.

Installation

Install the published PyPI package with uv:

uv tool install inksim

Then run it directly from your shell:

inksim design.pes

See installation and running for pip/virtual-environment installation and developer setup.

Quick start

inksim
inksim design.pes
inksim design.pes --play

Documentation

Background

The idea behind this tool dates back to 2013 with an experimental C++/Qt project called Orca, which originally explored graph algorithms for Inkscape on Linux before turning into a digitizer and stitch viewer. Here is an old recording of that early prototype in action:

Orca viewer demo

InkSim is a fresh, standalone rewrite of that viewer concept -- built from scratch using Python, PySide6, and Numba. The main goal is to provide a fast, lightweight way to preview embroidery files without heavy overhead.

It was built to fill a small workflow gap, and it's shared with the hope that others in the Inkscape and Ink/Stitch community might find it helpful as well.

Special thanks to the Ink/Stitch team and community for keeping open-source embroidery alive and inspiring.

License

InkSim is released under the GNU General Public License v3 or later.

Metadata

Release files for inksim 0.2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inksim 0.2.3
File Size Uploaded
inksim-0.2.3.tar.gz 91.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for inksim 0.2.3
File Interpreter ABI Platform
inksim-0.2.3-py3-none-any.whl Python 3 none any Details

Total release size: 194.8 kB

Release files / inksim-0.2.3.tar.gz

Download URL inksim-0.2.3.tar.gz
Size 91.9 kB
Tags Source
SHA-256 checksum
How to use checksums
6ff35a1f43cada689daf8e086828b0a4bd1764ec506279c8546bdfa83438d13f
BLAKE2b-256 checksum
How to use checksums
4d68a9e1bfa46259ad1c12070040d33cef80a653473283f7c3166ee9063cb91a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Release files / inksim-0.2.3-py3-none-any.whl

Download URL inksim-0.2.3-py3-none-any.whl
Size 102.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dbcdbc0662d245fe458f22f56a2e6e367c7650d1599262e7237cef1216dbc91c
BLAKE2b-256 checksum
How to use checksums
00f83b526b6e6dc6a467ed0ea8989c36574cb685edd38f6ee6faf7588a57d00b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Release history Release notifications | RSS feed

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.2.5

2 release files

0.2.4

2 release files

This release

0.2.3 This release

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page