OxiPhys setup
=============

1. Install Python 3.9 or newer, with Tk, if the computer has none.
   Windows and macOS: https://www.python.org/downloads/
     (on Windows keep "tcl/tk and IDLE" ticked and tick "Add python.exe to PATH").
   Linux: sudo apt install python3 python3-venv python3-tk
     (Fedora: sudo dnf install python3 python3-tkinter).

2. Start the setup program:
   Windows  double-click Install-OxiPhys-Windows.cmd
   macOS    double-click Install-OxiPhys-macOS.command
            (the first time: right-click it, Open, Open, because it is not signed)
   Linux    in a terminal: sh install-oxiphys-linux.sh

3. Choose the options on the first page and press Install. OxiPhys installs for your user
   account only, without administrator rights. Tick Gmsh to mesh built and imported geometry.

Without a window:  python oxiphys_setup.py --cli
Every option:      python oxiphys_setup.py --help
Update:            run setup again with the same install folder.
Uninstall:         Windows: Settings, Apps, OxiPhys, Uninstall.
                   macOS and Linux: run uninstall.sh in the install folder.

The full guide is at https://oxiphys.com/install.html

OxiPhys is free to use under the terms in LICENSE.txt. Code by others that ships with it is
listed in THIRD-PARTY-NOTICES.md. Copyright (c) 2026 Ashish Gad.
