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.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.1.3
File Size Uploaded
inksim-0.1.3.tar.gz 27.8 kB Details

Built distribution (wheel)

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

Total release size: 56.5 kB

Release files / inksim-0.1.3.tar.gz

Download URL inksim-0.1.3.tar.gz
Size 27.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3a6be099198d6ce63d1e304ebdeee36e9718d2fdb80ee673ebac57dab1d609be
BLAKE2b-256 checksum
How to use checksums
e67e7f328155169c623996f8375e0dffc4725e9676ccf381448e205a92e9cd20
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.3-py3-none-any.whl

Download URL inksim-0.1.3-py3-none-any.whl
Size 28.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7981b2124d78dc6eb0fc93a1bab8285c004c95b83f7a912c46f2a6077d1dc554
BLAKE2b-256 checksum
How to use checksums
c206ff3b6f7972dc07248b975dbc002d360dee792e09a915a345615bcffd9897
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

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

This release

0.1.3 This release

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