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.

The viewer now includes an OpenGL textured renderer that draws stitches as realistic ribbon quads with normal-mapped thread and Blinn-Phong lighting. Press Z in the viewer to toggle between the CPU and GPU renderers. The GPU renderer requires OpenGL 3.3; older systems and virtual machines fall back to the CPU raster renderer automatically.

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

Use inksim-gui design.pes to launch without a console window. The command names behave consistently on Windows, macOS, and Linux.

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.3.1

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.3.1
File Size Uploaded
inksim-0.3.1.tar.gz 474.3 kB Details

Built distribution (wheel)

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

Total release size: 968.0 kB

Release files / inksim-0.3.1.tar.gz

Download URL inksim-0.3.1.tar.gz
Size 474.3 kB
Tags Source
SHA-256 checksum
How to use checksums
584c385ad433629e193b3cfce2b78af16c7e67ae854110ddd80cc13e0ccd3885
BLAKE2b-256 checksum
How to use checksums
740cc6ee70c36b6141acd5d2527a0669967fa5ebb6d6390bb433b3b972561a0a
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.3.1-py3-none-any.whl

Download URL inksim-0.3.1-py3-none-any.whl
Size 493.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6af5093b563c72909378e300ecf1a15e951e54464d362ac81fa27466d5ef6ba4
BLAKE2b-256 checksum
How to use checksums
a2408e4dff492a3a231345d69613b0efeb9d640c3c53d7d1cd93c664b99d8576
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

This release

0.3.1 This release

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

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