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/wxPython/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

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

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

See installation and running for other Linux versions, pip/virtual-environment installation, and developer setup.

Quick start

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

Documentation

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

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.

Metadata

Release files for inksim 0.1.6

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.1.6
File Size Uploaded
inksim-0.1.6.tar.gz 28.9 kB Details

Built distribution (wheel)

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

Total release size: 64.5 kB

Release files / inksim-0.1.6.tar.gz

Download URL inksim-0.1.6.tar.gz
Size 28.9 kB
Tags Source
SHA-256 checksum
How to use checksums
420159e36c69f8aee9c2c54ea23379166e54e2c6696a5b39a794b9147718cc6b
BLAKE2b-256 checksum
How to use checksums
e0ea7394e9c6dc04993e6fd257dc8bcb921da4dae12881343f328620960caec8
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.1.6-py3-none-any.whl

Download URL inksim-0.1.6-py3-none-any.whl
Size 35.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e76ae38b31cc7ad43ddf2d5b919afbb56026d175c698abb0728fd34afa56692
BLAKE2b-256 checksum
How to use checksums
88db017b49e783f6451f5fa2546c989bbf2bf58c54245287d6461666f55c5de8
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

0.2.3

2 release files

This release

0.1.6 This release

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