Welcome to StringArt’s documentation!

StringArt lets you approximate an input image using a single continuous string looped around nails on the border of a canvas (see the documentation for an explanation of how the algorithm works). You can run it in three ways:

• Python API: call the functions directly in your own code or jupyter notebook.

• Command-Line Interface (CLI): run the tool from the terminal.

• Shiny WebApp: start the webapp from the terminal, then interact with the GUI using your browser (experimental).

Main algorithm and package name based on kaspar98/StringArt, rewritten from scratch with performance and usability in mind.

Improved/extra features:

• pip installable python package

• multiple interfaces available: python API, CLI, Shiny WebApp UI (experimental)

• improved performance thanks to caching, internal downscaling & some other tricks

• improved usability: reparametrized algorithm to allow for a more intuitive and precise control of the output image

Tutorials

• StringArt - Quick Usage Guide
  • StringArt description
    • Installation
      • Virtual environment (optional)
      • Installation instructions
    • Quickstart
      • Python API (code-based)
      • CLI (text-based)
      • Shiny WebApp (UI-based)
    • Parameters cheatsheet
• Detailed parameter description
  • Base parameters
  • Advanced parameters
• Preprocessing tips
  • Keep image constrast under control
  • Remove the background/trim the irrelevant portions of the image

Technical info

• Behind StringArt: how does its algorithm work?
• Performance analysis: caching

API Reference

• stringart package