Skip to content

Installation

Download Harnice for Mac or Windows. On a Mac, open the DMG and drag Harnice into Applications. On Windows, unzip and run Harnice.exe (keep the unzipped folder together).

Open Harnice. On first launch it creates the files it needs on this computer (your name and library locations).

Open or create a project

Use File → Open Project… or File → New Project… (same as the buttons in the console), or click those buttons in the left panel. Window → New Window opens another Harnice window with its own Python process so you can work on a different project at the same time.

Configure Library Paths

Harnice finds libraries through Library locations (in the left panel). Each row maps a repository URL (the lib_repo you write in build instructions) to the local path of that library on your machine:

repo_url,local_path
https://github.com/harnice/harnice-aerospace-library,/path/to/harnice-aerospace-library
https://github.com/harnice/harnice-av-library,/path/to/harnice-av-library
  • local_path may use ~ (it is expanded)
  • Add one row for every library you use. Connector choosers (D38999, Mighty Mouse, D-sub) look up https://github.com/harnice/harnice-aerospace-library with library_utils.get_local_path()
  • The URL must match exactly what you pass as lib_repo (lookup is case-insensitive)

If fileio.path("repository locations") is missing the first time you run Harnice, it is created for you.

See Libraries for more.

Install Supporting Applications

Make sure you have these applications installed for working with Harnice files:

  • Code editor - For editing build instructions (VSCode, Cursor, Notepad++, etc.)
  • SVG editor - Designed to work with Inkscape (used by the pdf_generator macro for SVG→PDF export)
  • CSV editor - Excel or similar spreadsheet application

Block diagrams and device symbols are edited in Harnice.