Installation

The GONet Wizard package provides tools for analyzing and monitoring data from GONet cameras. This guide walks you through setting up the environment and installing the package.

Choosing an installation path 

GONet Wizard can be used as a double-click desktop application, as a Python command-line package, or both. Choose the installation path that matches how you plan to work.

Installation path	Best for	What it provides
Desktop installer or DMG	Users who want to open the graphical interface without using a terminal.	A double-click `GONet Wizard` app that opens the GUI launcher. It does not add `GONet_Wizard` or `gonet-wizard` commands to your shell `PATH`.
Python package installation with `pip` or `pipx`	CLI users, scripted workflows, developers, and users who want both the terminal commands and the GUI command.	The `GONet_Wizard` and `gonet-wizard` command-line entry points. The GUI can also be started from the terminal with `GONet_Wizard gui`.

Important

Installing the desktop app is not the same as installing the Python command line package. The desktop app is meant to hide the terminal for GUI users. If you want terminal commands, install the Python package as described below.

Desktop app installation 

Desktop installers are distributed through the GitHub Releases page when a packaged build is available.

On macOS, the packaging path produces a drag-and-drop DMG containing GONet Wizard.app. After dragging the app to Applications, launch it by double-clicking the icon.

On Windows, the packaging path produces a Setup.exe installer. The installer adds a Start Menu shortcut and can optionally add a Desktop shortcut. It is a GUI installer only: it does not install terminal commands or modify PATH.

The desktop app opens the GUI launcher. It does not install command-line entry points, modify shell startup files, or add anything to PATH.

Early macOS DMGs and Windows installers may be unsigned. If your operating system blocks the app on first launch, see the release notes and any README file included with the release artifact for expected unsigned-build behavior.

Creating a Python environment 

It is highly recommended to use a dedicated environment for GONet Wizard to avoid conflicts with system packages.

You can create one using either venv or conda.

Using venv:

python -m venv gonet-env
source gonet-env/bin/activate  # On Windows: gonet-env\Scripts\activate
pip install --upgrade pip

Using conda:

conda create -n gonet-env python=3.10
conda activate gonet-env

Installing from GitHub 

You can install the latest development version of GONet Wizard directly from GitHub:

pip install git+https://github.com/gterreran/GONet_Wizard.git

To install a specific version or tag:

pip install git+https://github.com/gterreran/GONet_Wizard.git@v0.9.0

To install from a specific development branch:

pip install git+https://github.com/gterreran/GONet_Wizard.git@dev

Installing from a local clone 

If you wish to contribute to development or experiment with the source code, perform an editable install:

git clone https://github.com/gterreran/GONet_Wizard.git
cd GONet_Wizard
pip install -e .

This will install the package in-place, so any code changes are immediately reflected.

Installation via pyproject.toml 

GONet Wizard follows modern Python packaging standards using pyproject.toml and setuptools.

To build or install the package locally using this configuration:

pip install .

Or, for development mode:

pip install -e .

You do not need to run setup.py directly. It exists only for compatibility and delegates to pyproject.toml.

Python package installation tips for Windows users 

The Windows desktop installer does not require Python or Git. This section is only for users who want to install the Python package so they can use the CLI commands or develop the project locally.

Before installing the GONet Wizard package, ensure that you have both Python and Git installed and accessible from your terminal or command prompt.

Check if Python and Git are installed:

You can verify their availability with the following commands:

python --version
git --version

If either command results in a “command not found” error or opens a system prompt, follow the instructions to install them. On some systems, a prompt may appear automatically offering to install the missing component — accept it. This ensures the tools are correctly installed and added to your system’s PATH.

If the prompt does not appear, download them from:

Python: https://www.python.org/downloads/
Git: https://git-scm.com/downloads

Installing GONet Wizard via pip:

Once Python and Git are available, install GONet Wizard directly from GitHub using:

pip install git+https://github.com/gterreran/GONet_Wizard.git

Warning

After installation, you may see a message like:

WARNING: The script GONet_Wizard is installed in '/Users/yourname/.local/bin' which is not on PATH.

If so, you’ll need to add that directory to your system PATH.

To permanently add environment variables on Windows:

Press Win + S, search for Environment Variables, and select

Edit the system environment variables → Environment Variables…
Under User variables, click New.
Enter the variable name (e.g., PATH, GONET_ROOT) and its value (e.g., C:\Users\YourName\gonet\data).
Repeat for any additional variables (e.g., ROOT_EXT).
Click OK and restart your terminal for the changes to take effect.

These variables will be automatically loaded if you’re running the dashboard or CLI tools.

Run the CLI commands 

You are now ready to run any GONet Wizard command from the command line, e.g.:

GONet_Wizard gui

Troubleshooting 

If you encounter issues during install:

Try cleaning previous builds:
```
rm -rf build/ dist/ *.egg-info/
```
Ensure your environment is activated and Python ≥ 3.10 is installed
If installing from GitHub, ensure Git is installed and available in your PATH

For support or to open issues, visit: https://github.com/gterreran/GONet_Wizard/issues