Suite Installation

🚀 PyPottery Suite Launcher

The easiest way to get started with PyPottery! Download the pre-packaged launcher with everything included - no Python installation required.

Quick Start

The PyPottery Suite Launcher is a standalone application that lets you download, install, and run all PyPottery tools from a single, user-friendly interface.

No Technical Knowledge Required

The launcher handles everything: Python environment, dependencies, and app management. Just download, extract, and run!

Download

Download the PyPottery Suite Launcher for your operating system:

Platform Download Size
Windows 10/11 (64-bit) PyPottery-Launcher-Windows.zip ~52 MB
macOS Intel (x86_64) PyPottery-Launcher-macos-x86_64.zip ~22 MB
macOS Apple Silicon (M1/M2/M3) PyPottery-Launcher-macos-arm64.zip ~22 MB
Linux (x86_64) Coming Soon Coming Soon

Installation

Windows

  1. Download the Windows package from the link above
  2. Extract the ZIP file to a folder of your choice (e.g., C:\PyPottery)
  3. Run PyPottery.bat by double-clicking it
💡 Tip

You can create a desktop shortcut to PyPottery.bat for quick access!

macOS

  1. Download the appropriate package for your Mac:
    • Intel Mac: macos-x86_64 version
    • Apple Silicon (M1/M2/M3): macos-arm64 version
  2. Extract the ZIP file
  3. Double-click on the PyPottery Launcher.app file to launch the app
First Run on macOS

The first time you run the launcher, macOS may ask for permission. Right-click on the script and select “Open” to bypass Gatekeeper.

Don’t run on Download

Download folder doesn’t allow running the app. Move it to a different location (e.g, Desktop or Applications).

Linux

Linux of the installer is coming soon! Check back later.

Using the Launcher

Once the launcher opens, you’ll see a clean interface with all available PyPottery applications.

🎯 Launcher Features

📥 One-Click Download

Download apps directly from the launcher

🔄 Auto Updates

Check for and install updates easily

⚙️ Environment Setup

Automatic Python environment configuration

🖥️ Hardware Detection

Detects GPU for optimal performance

Step 1: Configure Environment

The first time you use the launcher, click “Configure Environment” to set up the Python environment. This installs all required dependencies.

⏱️ First Setup

Environment configuration may take 5-10 minutes depending on your internet connection. The progress bar shows the current status.

Step 2: Download Apps

Click the download button (⬇️) next to any app to download it. Available apps:

App Description
PyPotteryInk AI-based inking of pottery drawings
PyPotteryLayout Create publication-ready layouts
PyPotteryLens Data collection from PDF documents

Step 3: Launch Apps

Once an app is downloaded, click the “Launch” button to start it. The app will open in your default web browser.

ℹ️ How Apps Work

PyPottery apps run as local web servers. When you click "Launch", a browser window opens with the app interface. The launcher shows the running status and allows you to stop the app.

Troubleshooting

General Troubleshooting during the installation

Remove the pypottery_env folder and try again.

Windows: “Windows protected your PC” message

This is normal for new applications. Click “More info” → “Run anyway”.

Apps not downloading

Check your internet connection and firewall settings. The launcher downloads apps from GitHub.

Environment configuration fails

Try running the launcher as administrator (Windows).

Alternative: Manual Installation

If you prefer to install PyPottery tools manually or need more control, see the individual installation guides:

Ready to Start?

Download the launcher and begin digitizing your pottery collection!

📥 Download PyPottery Launcher