Skip to main content

InkSim

InkSim is a standalone embroidery simulator and preview renderer. It opens embroidery files, shows the stitch sequence, and lets you inspect or replay a design before production.

It is a normal Python desktop application installed from PyPI — not an Inkscape extension.

InkSim preview

The viewer 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 fall back to the CPU raster renderer automatically.

Thread texture detail
Detail of the normal-mapped thread texture used by the OpenGL renderer.

Install

uv tool install inksim

Requires Python 3.11+. See the installation guide for uv setup and alternative installers.

Run

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

On Windows, inksim-gui design.pes starts without a console window.

InkSim main window

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

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.11
File Size Uploaded
inksim-0.3.11.tar.gz 480.4 kB Details

Built distribution (wheel)

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

Total release size: 980.5 kB

Release files / inksim-0.3.11.tar.gz

Download URL inksim-0.3.11.tar.gz
Size 480.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e7029702ece9ac566854ed8d4dbbf92390eeb287b9501b58a84d18b8c4fb0980
BLAKE2b-256 checksum
How to use checksums
1248a24c0ba8bad90569e4f3b2c0aac1c6db563b433e553c4edb7457a3366d36
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.11-py3-none-any.whl

Download URL inksim-0.3.11-py3-none-any.whl
Size 500.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed6f186bcc54983ea50baec7ac7b19ab2759df525823734b565bfce91b1ac725
BLAKE2b-256 checksum
How to use checksums
f9ec74e14d473cc9ee38061c107c7893eb7b58a7781341a4ad65d7105900ccb4
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

This release

0.3.11 This release

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

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