From b270578a2845228b9735281b5a63b25ecf54a3b0 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Thu, 18 Sep 2025 16:53:46 +0100 Subject: [PATCH 01/29] add mac install instructions --- doc/gui.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/doc/gui.rst b/doc/gui.rst index 361681c40..34e172e87 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -25,6 +25,58 @@ To build larger games or to explore parameter spaces of a game systematically, it is recommended to use :ref:`the Python package `. +Install on Mac +============== + +To build and install the Gambit GUI on macOS, follow these steps: + +1. **Install build dependencies:** + + .. code-block:: bash + + brew install automake autoconf libtool + + .. note:: + If you encounter interpreter errors with autom4te, you may need to ensure + your Perl installation is correct or reinstall the autotools: + + .. code-block:: bash + + brew reinstall automake autoconf libtool + +2. **Download and build wxWidgets:** + + .. code-block:: bash + + curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 + tar xjf wxWidgets-3.2.8.tar.bz2 + cd wxWidgets-3.2.8 + mkdir build-release + cd build-release + ../configure --disable-shared --disable-sys-libs + make -j4 + sudo make install + +3. **Build and install Gambit:** + + Navigate back to the Gambit source directory and run: + + .. code-block:: bash + + aclocal + automake --add-missing + autoconf + ./configure + make + sudo make install + +4. **Create macOS application bundle:** + + To create a distributable DMG file: + + .. code-block:: bash + + make osx-dmg .. toctree:: :maxdepth: 2 From 7edeb84898524e6fe5768ef6fdb474fe2a6aa43d Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Thu, 18 Sep 2025 16:59:29 +0100 Subject: [PATCH 02/29] add mac, windows, linux --- doc/gui.rst | 80 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 34 deletions(-) diff --git a/doc/gui.rst b/doc/gui.rst index 34e172e87..040fd8940 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -25,58 +25,70 @@ To build larger games or to explore parameter spaces of a game systematically, it is recommended to use :ref:`the Python package `. -Install on Mac -============== +Installation Instructions +========================= -To build and install the Gambit GUI on macOS, follow these steps: +.. tab-set:: -1. **Install build dependencies:** + .. tab-item:: macOS - .. code-block:: bash + To build and install the Gambit GUI on macOS, follow these steps: - brew install automake autoconf libtool + 1. **Install build dependencies:** - .. note:: - If you encounter interpreter errors with autom4te, you may need to ensure - your Perl installation is correct or reinstall the autotools: + .. code-block:: bash - .. code-block:: bash + brew install automake autoconf libtool - brew reinstall automake autoconf libtool + .. note:: + If you encounter interpreter errors with autom4te, you may need to ensure + your Perl installation is correct or reinstall the autotools: -2. **Download and build wxWidgets:** + .. code-block:: bash - .. code-block:: bash + brew reinstall automake autoconf libtool - curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 - tar xjf wxWidgets-3.2.8.tar.bz2 - cd wxWidgets-3.2.8 - mkdir build-release - cd build-release - ../configure --disable-shared --disable-sys-libs - make -j4 - sudo make install + 2. **Download and build wxWidgets:** -3. **Build and install Gambit:** + .. code-block:: bash - Navigate back to the Gambit source directory and run: + curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 + tar xjf wxWidgets-3.2.8.tar.bz2 + cd wxWidgets-3.2.8 + mkdir build-release + cd build-release + ../configure --disable-shared --disable-sys-libs + make -j4 + sudo make install - .. code-block:: bash + 3. **Build and install Gambit:** - aclocal - automake --add-missing - autoconf - ./configure - make - sudo make install + Navigate back to the Gambit source directory and run: -4. **Create macOS application bundle:** + .. code-block:: bash - To create a distributable DMG file: + aclocal + automake --add-missing + autoconf + ./configure + make + sudo make install - .. code-block:: bash + 4. **Create macOS application bundle:** - make osx-dmg + To create a distributable DMG file: + + .. code-block:: bash + + make osx-dmg + + .. tab-item:: Windows + + TODO: Add Windows installation instructions + + .. tab-item:: Linux + + TODO: Add Linux installation instructions .. toctree:: :maxdepth: 2 From 6310fd81a0ee9fb715275def1a4a0ab8fbd30e4d Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Thu, 18 Sep 2025 17:01:05 +0100 Subject: [PATCH 03/29] Add final installation instruction for the Gambit application on macOS --- doc/gui.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/gui.rst b/doc/gui.rst index 040fd8940..a653cfe6d 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -82,6 +82,10 @@ Installation Instructions make osx-dmg + 5. **Install the application:** + + After creating the DMG file, open it and drag the Gambit application to your Applications folder. + .. tab-item:: Windows TODO: Add Windows installation instructions From 729fd4a6a252d2ae4a8c7b27e90ec9cd86321675 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 19 Sep 2025 10:51:11 +0100 Subject: [PATCH 04/29] update gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index ebc21507c..c787f7e46 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,5 @@ gambit .python-version dist .venv +*.dmg +Gambit.app/* \ No newline at end of file From 8a55070cc76e750c871981ee675af6add9f8991a Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 19 Sep 2025 11:40:15 +0100 Subject: [PATCH 05/29] link to releases page --- doc/gui.rst | 86 +++++++++++++++++++++++++---------------------------- 1 file changed, 40 insertions(+), 46 deletions(-) diff --git a/doc/gui.rst b/doc/gui.rst index a653cfe6d..9e83e59ab 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -25,74 +25,68 @@ To build larger games or to explore parameter spaces of a game systematically, it is recommended to use :ref:`the Python package `. -Installation Instructions -========================= +Installation +------------ -.. tab-set:: +To install the Gambit GUI, visit the `Gambit releases page on GitHub `_ and download the appropriate installer or package for your operating system. +Each release includes pre-built binaries for Windows, macOS, and Linux distributions, accessible under the "Assets" section of each release. - .. tab-item:: macOS +.. dropdown:: Manual macOS Build Instructions + :class-container: sd-border-0 + + To build and install the Gambit GUI from source on macOS, follow these steps: - To build and install the Gambit GUI on macOS, follow these steps: + 1. **Install build dependencies:** - 1. **Install build dependencies:** + .. code-block:: bash - .. code-block:: bash - - brew install automake autoconf libtool - - .. note:: - If you encounter interpreter errors with autom4te, you may need to ensure - your Perl installation is correct or reinstall the autotools: - - .. code-block:: bash + brew install automake autoconf libtool - brew reinstall automake autoconf libtool - - 2. **Download and build wxWidgets:** + .. note:: + If you encounter interpreter errors with autom4te, you may need to ensure + your Perl installation is correct or reinstall the autotools: .. code-block:: bash - curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 - tar xjf wxWidgets-3.2.8.tar.bz2 - cd wxWidgets-3.2.8 - mkdir build-release - cd build-release - ../configure --disable-shared --disable-sys-libs - make -j4 - sudo make install - - 3. **Build and install Gambit:** + brew reinstall automake autoconf libtool - Navigate back to the Gambit source directory and run: + 2. **Download and build wxWidgets:** - .. code-block:: bash + .. code-block:: bash - aclocal - automake --add-missing - autoconf - ./configure - make - sudo make install + curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 + tar xjf wxWidgets-3.2.8.tar.bz2 + cd wxWidgets-3.2.8 + mkdir build-release + cd build-release + ../configure --disable-shared --disable-sys-libs + make -j4 + sudo make install - 4. **Create macOS application bundle:** + 3. **Build and install Gambit:** - To create a distributable DMG file: + Navigate back to the Gambit source directory and run: - .. code-block:: bash + .. code-block:: bash - make osx-dmg + aclocal + automake --add-missing + autoconf + ./configure + make + sudo make install - 5. **Install the application:** + 4. **Create macOS application bundle:** - After creating the DMG file, open it and drag the Gambit application to your Applications folder. + To create a distributable DMG file: - .. tab-item:: Windows + .. code-block:: bash - TODO: Add Windows installation instructions + make osx-dmg - .. tab-item:: Linux + 5. **Install the application:** - TODO: Add Linux installation instructions + After creating the DMG file, open it and drag the Gambit application to your Applications folder. .. toctree:: :maxdepth: 2 From 77917da6eec86b08c212d2d8866628303468f972 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Tue, 7 Oct 2025 09:52:59 +0100 Subject: [PATCH 06/29] update min wxWidgets version to 3.2.x --- doc/developer.build.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 62a8f4706..73b5aca50 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -90,7 +90,7 @@ instructions for Un*x/Linux platforms above. The graphical interface and wxWidgets ------------------------------------- -Gambit requires wxWidgets version 3.1.x or higher. +Gambit requires wxWidgets version 3.2.x or higher. See the wxWidgets website at ``_ to download this if you need it. Packages of this should be available From aad33d60e1017133d89dc9f7cc618e00b465b9bc Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Tue, 7 Oct 2025 10:04:51 +0100 Subject: [PATCH 07/29] move dev instructions to dev doc --- doc/developer.build.rst | 58 +++++++++++++++++++++++++++++++++-------- doc/gui.rst | 57 +--------------------------------------- 2 files changed, 48 insertions(+), 67 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 73b5aca50..26df8a6f7 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -86,11 +86,57 @@ For OS X users For building the command-line tools only, one should follow the instructions for Un*x/Linux platforms above. +.. _build-gui: The graphical interface and wxWidgets ------------------------------------- -Gambit requires wxWidgets version 3.2.x or higher. +.. dropdown:: Manual macOS Build Instructions + :class-container: sd-border-0 + + To build and install the Gambit GUI from source on macOS, follow these steps: + + 1. **Install build dependencies:** + + .. code-block:: bash + + brew install automake autoconf libtool wxwidgets + + .. note:: + If you encounter interpreter errors with autom4te, you may need to ensure + your Perl installation is correct or reinstall the autotools: + + .. code-block:: bash + + brew reinstall automake autoconf libtool wxwidgets + + 2. **Build and install Gambit:** + + Navigate back to the Gambit source directory and run: + + .. code-block:: bash + + aclocal + automake --add-missing + autoconf + ./configure + make + sudo make install + + 3. **Create macOS application bundle:** + + To create a distributable DMG file: + + .. code-block:: bash + + make osx-dmg + + 4. **Install the application:** + + After creating the DMG file, open it and drag the Gambit application to your Applications folder. + + +Note that Gambit requires wxWidgets version 3.2.x or higher. See the wxWidgets website at ``_ to download this if you need it. Packages of this should be available @@ -116,16 +162,6 @@ can either (a) simply not install wxWidgets, or (b) pass the argument This will just build the command-line tools, and will not require a wxWidgets installation. -For OS X users, after the usual ``make`` step, run - - make osx-bundle - -This produces an application ``Gambit.app`` in the current directory, -which can be run from its current location, or copied elsewhere in the -disk (such as ``/Applications``). The application bundle includes the -command-line executables. - - .. _build-python: diff --git a/doc/gui.rst b/doc/gui.rst index 9e83e59ab..f54df23a6 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -31,62 +31,7 @@ Installation To install the Gambit GUI, visit the `Gambit releases page on GitHub `_ and download the appropriate installer or package for your operating system. Each release includes pre-built binaries for Windows, macOS, and Linux distributions, accessible under the "Assets" section of each release. -.. dropdown:: Manual macOS Build Instructions - :class-container: sd-border-0 - - To build and install the Gambit GUI from source on macOS, follow these steps: - - 1. **Install build dependencies:** - - .. code-block:: bash - - brew install automake autoconf libtool - - .. note:: - If you encounter interpreter errors with autom4te, you may need to ensure - your Perl installation is correct or reinstall the autotools: - - .. code-block:: bash - - brew reinstall automake autoconf libtool - - 2. **Download and build wxWidgets:** - - .. code-block:: bash - - curl -L -O https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.8/wxWidgets-3.2.8.tar.bz2 - tar xjf wxWidgets-3.2.8.tar.bz2 - cd wxWidgets-3.2.8 - mkdir build-release - cd build-release - ../configure --disable-shared --disable-sys-libs - make -j4 - sudo make install - - 3. **Build and install Gambit:** - - Navigate back to the Gambit source directory and run: - - .. code-block:: bash - - aclocal - automake --add-missing - autoconf - ./configure - make - sudo make install - - 4. **Create macOS application bundle:** - - To create a distributable DMG file: - - .. code-block:: bash - - make osx-dmg - - 5. **Install the application:** - - After creating the DMG file, open it and drag the Gambit application to your Applications folder. +Developers should refer to the :ref:`build instructions ` for details on building the GUI from source. .. toctree:: :maxdepth: 2 From 719949a0291009f4d2d96c73a2037ac5d5f2f362 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 13:33:46 +0000 Subject: [PATCH 08/29] add install page and move pygmabit install instructions there --- doc/index.rst | 1 + doc/install.rst | 19 +++++++++++++++++++ doc/pygambit.rst | 10 ---------- 3 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 doc/install.rst diff --git a/doc/index.rst b/doc/index.rst index 2fcb284f3..4723177d4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -63,6 +63,7 @@ construction and analysis of finite extensive and strategic games. :maxdepth: 1 intro + install pygambit tools gui diff --git a/doc/install.rst b/doc/install.rst new file mode 100644 index 000000000..15a058edd --- /dev/null +++ b/doc/install.rst @@ -0,0 +1,19 @@ +.. _install: + + +Install +======= + +Users installing Gambit have several options depending on their needs and their operating system. +We recommended new most users install the PyGambit package and read the :ref:`PyGambit documentation `. + +Installing PyGambit +------------------- + +PyGambit is available on `PyPI `_. We recommend installing it into a Python virtual environment via `pip`:: + + pip install pygambit + + +Installing Gambit GUI & CLI tools +--------------------------------- \ No newline at end of file diff --git a/doc/pygambit.rst b/doc/pygambit.rst index 556a80afb..b07ae7f49 100644 --- a/doc/pygambit.rst +++ b/doc/pygambit.rst @@ -4,16 +4,6 @@ PyGambit ======== -Gambit provides a Python package, ``pygambit``, which is available on `PyPI -`_. - -Installation ------------- - -To install the package, use the following command:: - - pip install pygambit - .. toctree:: :maxdepth: 2 From 3b25dae28f7307b55725c04a3ad32ba0bebf0794 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 13:43:34 +0000 Subject: [PATCH 09/29] move GUI and CLI install instructions to install.rst --- doc/gui.rst | 8 -------- doc/install.rst | 7 ++++++- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/doc/gui.rst b/doc/gui.rst index f54df23a6..6e032352d 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -25,14 +25,6 @@ To build larger games or to explore parameter spaces of a game systematically, it is recommended to use :ref:`the Python package `. -Installation ------------- - -To install the Gambit GUI, visit the `Gambit releases page on GitHub `_ and download the appropriate installer or package for your operating system. -Each release includes pre-built binaries for Windows, macOS, and Linux distributions, accessible under the "Assets" section of each release. - -Developers should refer to the :ref:`build instructions ` for details on building the GUI from source. - .. toctree:: :maxdepth: 2 diff --git a/doc/install.rst b/doc/install.rst index 15a058edd..88bd4374f 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -7,6 +7,8 @@ Install Users installing Gambit have several options depending on their needs and their operating system. We recommended new most users install the PyGambit package and read the :ref:`PyGambit documentation `. +Developers & contributors should refer to the :ref:`developer docs ` which contain guides for building Gambit from source and contributing to the project. + Installing PyGambit ------------------- @@ -16,4 +18,7 @@ PyGambit is available on `PyPI `_. We recomm Installing Gambit GUI & CLI tools ---------------------------------- \ No newline at end of file +--------------------------------- + +To install the Gambit :ref:`GUI ` and :ref:`CLI tools `, visit the `Gambit releases page on GitHub `_ and download the appropriate installer or package for your operating system. +Each release includes pre-built binaries for Windows, macOS, and Linux distributions, accessible under the "Assets" section of each release. From 618b75755d9ee5c464814ffb003a54c6d4c0fb52 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 13:59:51 +0000 Subject: [PATCH 10/29] refactor homepage --- doc/index.rst | 18 ++++++++---------- doc/install.rst | 2 +- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 4723177d4..22560eca3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,29 +4,28 @@ Gambit: User documentation **Gambit** is a library of game theory software and tools for the construction and analysis of finite extensive and strategic games. +We recommended most new users install the PyGambit Python package and read the associated documentation, which includes tutorials and a complete API reference. .. grid:: - .. grid-item-card:: Python user guide + .. grid-item-card:: Installing Gambit :columns: 6 - An introduction to using the ``pygambit`` package - in Python. + Get started by installing Gambit. PyGambit quickstart: ``pip install pygambit`` - .. button-ref:: pygambit-user + .. button-ref:: install :ref-type: ref :click-parent: :color: secondary :expand: - .. grid-item-card:: Python API reference + .. grid-item-card:: PyGambit Python package :columns: 6 - The complete reference to all the functionality - of ``pygambit``. + Create games and compute equilibria with the PyGambit package. - .. button-ref:: pygambit-api + .. button-ref:: pygambit :ref-type: ref :click-parent: :color: secondary @@ -36,8 +35,7 @@ construction and analysis of finite extensive and strategic games. .. grid-item-card:: Command-line tools :columns: 6 - All Gambit's methods for equilibrium computation are - available via command-line programs. + Quickly compute equilibria with the Gambit command-line tools. .. button-ref:: command-line :ref-type: ref diff --git a/doc/install.rst b/doc/install.rst index 88bd4374f..41659450a 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -5,7 +5,7 @@ Install ======= Users installing Gambit have several options depending on their needs and their operating system. -We recommended new most users install the PyGambit package and read the :ref:`PyGambit documentation `. +We recommended most new users install the PyGambit package and read the :ref:`PyGambit documentation `. Developers & contributors should refer to the :ref:`developer docs ` which contain guides for building Gambit from source and contributing to the project. From 96fc10cc50ac93f9f243e40255270a0dea570aa3 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:03:41 +0000 Subject: [PATCH 11/29] link to install page --- doc/gui.rst | 2 ++ doc/install.rst | 2 ++ doc/pygambit.rst | 2 ++ doc/tools.rst | 2 ++ 4 files changed, 8 insertions(+) diff --git a/doc/gui.rst b/doc/gui.rst index 6e032352d..83e6e1009 100644 --- a/doc/gui.rst +++ b/doc/gui.rst @@ -4,6 +4,8 @@ GUI *** +See installation instructions in the :ref:`install-cli-gui` section. + Gambit's graphical user interface provides an "integrated development environment" to help visually construct games and to investigate their main strategic features. diff --git a/doc/install.rst b/doc/install.rst index 41659450a..2dd9119bf 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -17,6 +17,8 @@ PyGambit is available on `PyPI `_. We recomm pip install pygambit +.. _install-cli-gui: + Installing Gambit GUI & CLI tools --------------------------------- diff --git a/doc/pygambit.rst b/doc/pygambit.rst index b07ae7f49..853978bd1 100644 --- a/doc/pygambit.rst +++ b/doc/pygambit.rst @@ -4,6 +4,8 @@ PyGambit ======== +See installation instructions in the :ref:`install` section. + .. toctree:: :maxdepth: 2 diff --git a/doc/tools.rst b/doc/tools.rst index 542c5bf4e..8a3643b79 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -4,6 +4,8 @@ CLI *** +See installation instructions in the :ref:`install-cli-gui` section. + Gambit provides command-line interfaces for each method for computing Nash equilibria. These are suitable for scripting or calling from other programs. This chapter describes the use of these programs. From c6e9ffb6bd9ff552169b54d576ea0a8e0b3c0a38 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:07:03 +0000 Subject: [PATCH 12/29] mention older versions --- doc/install.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/install.rst b/doc/install.rst index 2dd9119bf..5cd617fdb 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -17,6 +17,9 @@ PyGambit is available on `PyPI `_. We recomm pip install pygambit +Older releases can be installed by specifying the version number. +Visit the `Gambit releases page on GitHub `_ for information on older versions. + .. _install-cli-gui: Installing Gambit GUI & CLI tools From 8f5526e9549f3dd9560f607e9d9328e71a26476d Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:42:44 +0000 Subject: [PATCH 13/29] mac install from disk --- doc/install.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/install.rst b/doc/install.rst index 5cd617fdb..d6ab2e1bc 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -27,3 +27,24 @@ Installing Gambit GUI & CLI tools To install the Gambit :ref:`GUI ` and :ref:`CLI tools `, visit the `Gambit releases page on GitHub `_ and download the appropriate installer or package for your operating system. Each release includes pre-built binaries for Windows, macOS, and Linux distributions, accessible under the "Assets" section of each release. + +.. dropdown:: Install on macOS with disk image + :class-container: sd-border-0 + + 1. **Download the .dmg installer:** + + Visit the `Gambit releases page on GitHub `_ and download the `.dmg` file for the version of Gambit you wish to install. + + 2. **Install the application:** + + Double click the `.dmg` file to mount it, then drag the Gambit application to your Applications folder. + + .. note:: + You may need to adjust your macOS security settings to allow the installation of applications from unidentified developers. + + This can be done in ``System Preferences > Security & Privacy`` (see `Apple's documentation `_ for more details). + + If your administration privileges prevent this, try the Homebrew installation method below, or build from source as described in the :ref:`developer build instructions `. + +.. dropdown:: Install on macOS via Homebrew + :class-container: sd-border-0 \ No newline at end of file From 001a1452f00922576859e64db40a5bc7f63373ba Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:49:23 +0000 Subject: [PATCH 14/29] add homebrew option --- doc/install.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index d6ab2e1bc..ddda0d8d3 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -39,7 +39,7 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut Double click the `.dmg` file to mount it, then drag the Gambit application to your Applications folder. - .. note:: + .. warning:: You may need to adjust your macOS security settings to allow the installation of applications from unidentified developers. This can be done in ``System Preferences > Security & Privacy`` (see `Apple's documentation `_ for more details). @@ -47,4 +47,15 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut If your administration privileges prevent this, try the Homebrew installation method below, or build from source as described in the :ref:`developer build instructions `. .. dropdown:: Install on macOS via Homebrew - :class-container: sd-border-0 \ No newline at end of file + :class-container: sd-border-0 + + 1. Check that you have Homebrew installed by running `brew --version`. If not, follow the instructions at `https://brew.sh/ `_. + + 2. Install Gambit using Homebrew: + + .. code-block:: bash + + brew install gambit + + .. warning:: + Homebrew installation has not been set up or tested by the Gambit development team. \ No newline at end of file From 7b25f7ca245a8aff1255a26e14d955f364b3d603 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:52:06 +0000 Subject: [PATCH 15/29] add installation instructions for building Gambit from source tarball --- doc/install.rst | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index ddda0d8d3..7686e0f6d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -58,4 +58,29 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut brew install gambit .. warning:: - Homebrew installation has not been set up or tested by the Gambit development team. \ No newline at end of file + Homebrew installation has not been set up or tested by the Gambit development team. + +.. dropdown:: Install on Linux or macOS from source tarball + :class-container: sd-border-0 + + 1. **Download the source tarball:** + + Visit the `Gambit releases page on GitHub `_ and download the source tarball for the version of Gambit you wish to install. + + 2. **Extract the tarball:** + + Once downloaded, extract the tarball using the following command: + + .. code-block:: bash + + tar -xzf gambit-*.tar.gz + + 3. **Build and install Gambit:** + + Navigate to the extracted directory and run: + + .. code-block:: bash + + ./configure + make + sudo make install \ No newline at end of file From 1ad1782b5e9a96afb740765b693b60643aa72309 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:54:40 +0000 Subject: [PATCH 16/29] add installation instructions for Windows using installer --- doc/install.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index 7686e0f6d..14acd0a01 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -83,4 +83,15 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut ./configure make - sudo make install \ No newline at end of file + sudo make install + +.. dropdown:: Install on Windows with installer + :class-container: sd-border-0 + + 1. **Download the installer:** + + Visit the `Gambit releases page on GitHub `_ and download the `.msi`. + + 2. **Run the installer:** + + Double click the downloaded `.msi` file and follow the on-screen instructions to complete the installation. \ No newline at end of file From 6511ce07373176877da59f59cc5f0bf493b4cd96 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:58:04 +0000 Subject: [PATCH 17/29] fix spacing --- doc/install.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 14acd0a01..aaa56ecc0 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -63,27 +63,27 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut .. dropdown:: Install on Linux or macOS from source tarball :class-container: sd-border-0 - 1. **Download the source tarball:** + 1. **Download the source tarball:** - Visit the `Gambit releases page on GitHub `_ and download the source tarball for the version of Gambit you wish to install. + Visit the `Gambit releases page on GitHub `_ and download the source tarball for the version of Gambit you wish to install. - 2. **Extract the tarball:** + 2. **Extract the tarball:** - Once downloaded, extract the tarball using the following command: + Once downloaded, extract the tarball using the following command: - .. code-block:: bash + .. code-block:: bash - tar -xzf gambit-*.tar.gz + tar -xzf gambit-*.tar.gz - 3. **Build and install Gambit:** + 3. **Build and install Gambit:** - Navigate to the extracted directory and run: + Navigate to the extracted directory and run: - .. code-block:: bash + .. code-block:: bash - ./configure - make - sudo make install + ./configure + make + sudo make install .. dropdown:: Install on Windows with installer :class-container: sd-border-0 @@ -92,6 +92,6 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut Visit the `Gambit releases page on GitHub `_ and download the `.msi`. - 2. **Run the installer:** + 2. **Run the installer:** - Double click the downloaded `.msi` file and follow the on-screen instructions to complete the installation. \ No newline at end of file + Double click the downloaded `.msi` file and follow the on-screen instructions to complete the installation. \ No newline at end of file From 7015e916890dfffc0ea98ff486b3b08fe3982f33 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 14:58:38 +0000 Subject: [PATCH 18/29] fix spacing --- doc/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index aaa56ecc0..7f9090cc5 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -61,7 +61,7 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut Homebrew installation has not been set up or tested by the Gambit development team. .. dropdown:: Install on Linux or macOS from source tarball - :class-container: sd-border-0 + :class-container: sd-border-0 1. **Download the source tarball:** From ba69446964ab47fd8d0ed6f93765639a2bea7e66 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:08:01 +0000 Subject: [PATCH 19/29] revise first para of developer doc --- doc/developer.build.rst | 7 ++++--- doc/developer.contributing.rst | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 26df8a6f7..0d8096a8a 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -5,10 +5,11 @@ This section covers instructions for building Gambit from source. This is for those who are interested in developing Gambit, or who want to play around with the latest features before they make it into a pre-compiled binary version. +Developers and contributors should first refer to the :ref:`contributor page ` which explains how to clone the Gambit repository from GitHub. This section requires at least some familiarity with programming. -Most users will want to stick with binary distributions; see -:ref:`section-downloading` for how to get the current version for +Most users will want to stick with binary distributions; see the +:ref:`install` page for how to get the current version for your operating system. General information @@ -86,7 +87,7 @@ For OS X users For building the command-line tools only, one should follow the instructions for Un*x/Linux platforms above. -.. _build-gui: +.. _build-mac: The graphical interface and wxWidgets ------------------------------------- diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index daf27fcac..1a48f733f 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -22,6 +22,8 @@ When reporting a bug, please be sure to include the following: sample game file or files if appropriate; it is often helpful to simplify the game if possible. +.. _contributing-code: + Contributing code ---------------- From 9e19f2f16c56217772755113cc4fdd7926b06850 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:14:06 +0000 Subject: [PATCH 20/29] install from source steps --- doc/developer.build.rst | 61 +++++++++++++++++------------------------ doc/install.rst | 16 +++++++++++ 2 files changed, 41 insertions(+), 36 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 0d8096a8a..d0685ac5c 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -12,37 +12,6 @@ Most users will want to stick with binary distributions; see the :ref:`install` page for how to get the current version for your operating system. -General information -------------------- - -Gambit uses the standard autotools mechanism for configuring and building. -This should be familiar to most users of Un*ces and MacOS X. - -If you are building from a source tarball, -you just need to unpack the sources, change directory to the top level -of the sources (typically of the form gambit-xx.y.z), and do the -usual :: - - ./configure - make - sudo make install - -Command-line options are available to modify the configuration process; -do `./configure --help` for information. Of these, the option which -may be most useful is to disable the build of the graphical interface - -By default Gambit will be installed in /usr/local. You can change this -by replacing configure step with one of the form :: - - ./configure --prefix=/your/path/here - -.. note:: - The graphical interface relies on external calls to other - programs built in this process, especially for the computation of - equilibria. It is strongly recommended that you install the Gambit - executables to a directory in your path! - - Building from git repository ---------------------------- @@ -63,8 +32,29 @@ After this, you will need to set up the build scripts by executing :: For this, you will need to have automake, autoconf, and libtool2 installed on your system. -At this point, you can then continue with the configuration and build -stages as in the previous section. +You can then configure and build Gambit like so: + +.. code-block:: bash + + ./configure + make + sudo make install + +.. note:: + Command-line options are available to modify the configuration process; + do `./configure --help` for information. Of these, the option which + may be most useful is to disable the build of the graphical interface. + + By default Gambit will be installed in /usr/local. You can change this + by replacing configure step with one of the form :: + + `./configure --prefix=/your/path/here` + +.. warning:: + The graphical interface relies on external calls to other + programs built in this process, especially for the computation of + equilibria. It is strongly recommended that you install the Gambit + executables to a directory in your path! In the git repository, the branch ``master`` always points to the latest development version. New development should in general always @@ -89,9 +79,6 @@ instructions for Un*x/Linux platforms above. .. _build-mac: -The graphical interface and wxWidgets -------------------------------------- - .. dropdown:: Manual macOS Build Instructions :class-container: sd-border-0 @@ -136,6 +123,8 @@ The graphical interface and wxWidgets After creating the DMG file, open it and drag the Gambit application to your Applications folder. +The graphical interface and wxWidgets +------------------------------------- Note that Gambit requires wxWidgets version 3.2.x or higher. See the wxWidgets website at diff --git a/doc/install.rst b/doc/install.rst index 7f9090cc5..0a3dd4ea9 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -85,6 +85,22 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut make sudo make install + .. note:: + Command-line options are available to modify the configuration process; + do `./configure --help` for information. Of these, the option which + may be most useful is to disable the build of the graphical interface. + + By default Gambit will be installed in /usr/local. You can change this + by replacing configure step with one of the form :: + + `./configure --prefix=/your/path/here` + + .. warning:: + The graphical interface relies on external calls to other + programs built in this process, especially for the computation of + equilibria. It is strongly recommended that you install the Gambit + executables to a directory in your path! + .. dropdown:: Install on Windows with installer :class-container: sd-border-0 From 79fe467334210b3db16bfadfc028f421023e1665 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:31:51 +0000 Subject: [PATCH 21/29] sections of developer doc --- doc/developer.build.rst | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index d0685ac5c..ea49a6c6f 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -1,26 +1,33 @@ Building Gambit from source =========================== -This section covers instructions for building Gambit from source. +This page covers instructions for building Gambit from source. This is for those who are interested in developing Gambit, or who want to play around with the latest features before they make it into a pre-compiled binary version. -Developers and contributors should first refer to the :ref:`contributor page ` which explains how to clone the Gambit repository from GitHub. -This section requires at least some familiarity with programming. -Most users will want to stick with binary distributions; see the +This page requires at least some familiarity with programming. +Most users will want to stick with released distributions; see the :ref:`install` page for how to get the current version for your operating system. +Following the instructions here will install the Gambit CLI, GUI and Python extension (PyGambit). -Building from git repository ----------------------------- +The steps you will need to follow to build from source are as follows: -If you want to live on the bleeding edge, you can get the latest -version of the Gambit sources from the Gambit repository on -github.com, via :: +1. Refer to the :ref:`contributor page ` which explains how to clone the Gambit repository from GitHub (you may first wish to create a fork). +2. :ref:`Install the necessary build tools and dependencies for your platform `. +3. :ref:`Follow the platform-specific instructions to build and install Gambit CLI and GUI components from source `. +4. :ref:`Build the Python extension (PyGambit) `. - git clone https://github.com/gambitproject/gambit.git - cd gambit +.. _source-dependencies: + +Install build tools and dependencies +------------------------------------ + +.. _cli-gui-from-source: + +Install CLI and GUI from source +-------------------------------- After this, you will need to set up the build scripts by executing :: From d9162d0dd19c7a46e6bfd302b434f86ac42f0ced Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:38:42 +0000 Subject: [PATCH 22/29] build from source link --- doc/developer.build.rst | 2 ++ doc/install.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index ea49a6c6f..f2a0eb272 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -1,3 +1,5 @@ +.. _building-from-source: + Building Gambit from source =========================== diff --git a/doc/install.rst b/doc/install.rst index 0a3dd4ea9..8af5e8c10 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -44,7 +44,7 @@ Each release includes pre-built binaries for Windows, macOS, and Linux distribut This can be done in ``System Preferences > Security & Privacy`` (see `Apple's documentation `_ for more details). - If your administration privileges prevent this, try the Homebrew installation method below, or build from source as described in the :ref:`developer build instructions `. + If your administration privileges prevent this, try the Homebrew installation method below, or build from source as described in the :ref:`developer build instructions `. .. dropdown:: Install on macOS via Homebrew :class-container: sd-border-0 From 5a16819f32f71249e62039ee340569e787753089 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:41:32 +0000 Subject: [PATCH 23/29] mac dependencies --- doc/developer.build.rst | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index f2a0eb272..3cc2589d1 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -26,6 +26,25 @@ The steps you will need to follow to build from source are as follows: Install build tools and dependencies ------------------------------------ +.. dropdown:: Install on macOS via Homebrew + :class-container: sd-border-0 + + 1. Check that you have Homebrew installed by running `brew --version`. If not, follow the instructions at `https://brew.sh/ `_. + + 2. Install build dependencies: + + .. code-block:: bash + + brew install automake autoconf libtool wxwidgets + + .. note:: + If you encounter interpreter errors with autom4te, you may need to ensure + your Perl installation is correct or reinstall the autotools: + + .. code-block:: bash + + brew reinstall automake autoconf libtool wxwidgets + .. _cli-gui-from-source: Install CLI and GUI from source @@ -86,26 +105,8 @@ For OS X users For building the command-line tools only, one should follow the instructions for Un*x/Linux platforms above. -.. _build-mac: - .. dropdown:: Manual macOS Build Instructions :class-container: sd-border-0 - - To build and install the Gambit GUI from source on macOS, follow these steps: - - 1. **Install build dependencies:** - - .. code-block:: bash - - brew install automake autoconf libtool wxwidgets - - .. note:: - If you encounter interpreter errors with autom4te, you may need to ensure - your Perl installation is correct or reinstall the autotools: - - .. code-block:: bash - - brew reinstall automake autoconf libtool wxwidgets 2. **Build and install Gambit:** From 00da0f3a4b2b14f51101ef0fe494e5eaa3038675 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 15:59:20 +0000 Subject: [PATCH 24/29] linux dependencies --- doc/developer.build.rst | 66 +++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 3cc2589d1..4ceef06f0 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -45,6 +45,31 @@ Install build tools and dependencies brew reinstall automake autoconf libtool wxwidgets +.. dropdown:: Install on Linux (Debian/Ubuntu) via apt + :class-container: sd-border-0 + + 1. Update your package lists: + + .. code-block:: bash + + sudo apt update + + 2. Install general build dependencies: + + .. code-block:: bash + + sudo apt install build-essential automake autoconf libtool + + 3. Install GUI dependencies (replace X.X with the latest version available, e.g., 3.2): + + .. code-block:: bash + + sudo apt-cache search libwxgt* + sudo apt install libwxgtkX.X-dev + + .. note:: + Note that Gambit requires wxWidgets version 3.2.x or higher. + .. _cli-gui-from-source: Install CLI and GUI from source @@ -90,6 +115,22 @@ be based off this branch. Branches labeled ``maintVV``, where ``VV`` is the version number, point to the latest commit on a stable version. +For Un*x/Linux users: +If wxWidgets it isn't installed in a standard place (e.g., /usr or +/usr/local), you'll need to tell configure where to find it with the +--with-wx-prefix=PREFIX option, for example:: + + ./configure --with-wx-prefix=/home/mylogin/wx + +Finally, if you don't want to build the graphical interface, you +can either (a) simply not install wxWidgets, or (b) pass the argument +--disable-gui to the configure step, for example, :: + + ./configure --disable-gui + +This will just build the command-line tools, and will not require +a wxWidgets installation. + For Windows users ----------------- @@ -133,34 +174,9 @@ instructions for Un*x/Linux platforms above. After creating the DMG file, open it and drag the Gambit application to your Applications folder. -The graphical interface and wxWidgets -------------------------------------- - -Note that Gambit requires wxWidgets version 3.2.x or higher. -See the wxWidgets website at -``_ -to download this if you need it. Packages of this should be available -for most Un*x users through their package managers (apt or rpm). Note -that you'll need the appropriate -dev package for wxWidgets to get the -header files needed to build Gambit. - -Un*x users, please note that Gambit at this time only supports the -GTK port of wxWidgets. - -If wxWidgets it isn't installed in a standard place (e.g., /usr or -/usr/local), you'll need to tell configure where to find it with the ---with-wx-prefix=PREFIX option, for example:: - ./configure --with-wx-prefix=/home/mylogin/wx -Finally, if you don't want to build the graphical interface, you -can either (a) simply not install wxWidgets, or (b) pass the argument ---disable-gui to the configure step, for example, :: - - ./configure --disable-gui -This will just build the command-line tools, and will not require -a wxWidgets installation. .. _build-python: From 370bd39401e491d65b9b63c8188895849f53a971 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 16:04:36 +0000 Subject: [PATCH 25/29] no windows instructions for now --- doc/developer.build.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 4ceef06f0..5b549e1df 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -70,6 +70,12 @@ Install build tools and dependencies .. note:: Note that Gambit requires wxWidgets version 3.2.x or higher. +.. dropdown:: Install on Windows + :class-container: sd-border-0 + + .. warning:: + TODO: Add Windows build dependencies instructions here. + .. _cli-gui-from-source: Install CLI and GUI from source From 6d2015f9e92f065cd48a70a833c9bc9065c5bdc6 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 16:13:55 +0000 Subject: [PATCH 26/29] move branch info to contributing section --- doc/developer.contributing.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 1a48f733f..fde7bd264 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -30,6 +30,12 @@ Contributing code Gambit is an open-source project, and contributions are welcome from anyone. The project is hosted on GitHub, and contributions can be made via pull requests following the standard GitHub workflow. +In the git repository, the branch ``master`` always points to the +latest development version. New development should in general always +be based off this branch. Branches labeled ``maintVV``, where ``VV`` +is the version number, point to the latest commit on a stable +version. + 1. To get started contributing code in the `Gambit GitHub repo `__, do one of the following: - Core developers: request contributor access from one of the `team `__ From 444b6fe3c20a1878c8faf8ec96db954c9874ba08 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 16:24:30 +0000 Subject: [PATCH 27/29] refactor developer install doc --- doc/developer.build.rst | 93 ++++++++++++----------------------------- 1 file changed, 26 insertions(+), 67 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 5b549e1df..980f9f604 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -81,24 +81,38 @@ Install build tools and dependencies Install CLI and GUI from source -------------------------------- -After this, you will need to set up the build scripts by executing :: - - aclocal - libtoolize - automake --add-missing - autoconf +.. dropdown:: Install on Windows + :class-container: sd-border-0 -For this, you will need to have automake, autoconf, and libtool2 -installed on your system. + .. warning:: + For Windows users wanting to compile Gambit on their own, you'll need to use either the Cygwin or MinGW environments. We do compilation and testing of Gambit on Windows using MinGW. -You can then configure and build Gambit like so: +The rest of these instructions are applicable to **Linux** and **macOS** users. +Navigate to the Gambit source directory and run: .. code-block:: bash + aclocal + libtoolize + automake --add-missing + autoconf ./configure make sudo make install +.. note:: + If you don't want to build the graphical interface, you can pass the argument `--disable-gui` to the configure step, for example, :: + + `./configure --disable-gui` + +.. warning:: + For Linux users: + If wxWidgets it isn't installed in a standard place (e.g., /usr or + /usr/local), you'll need to tell configure where to find it with the + `--with-wx-prefix=PREFIX` option, for example:: + + `./configure --with-wx-prefix=/home/mylogin/wx` + .. note:: Command-line options are available to modify the configuration process; do `./configure --help` for information. Of these, the option which @@ -115,60 +129,10 @@ You can then configure and build Gambit like so: equilibria. It is strongly recommended that you install the Gambit executables to a directory in your path! -In the git repository, the branch ``master`` always points to the -latest development version. New development should in general always -be based off this branch. Branches labeled ``maintVV``, where ``VV`` -is the version number, point to the latest commit on a stable -version. - -For Un*x/Linux users: -If wxWidgets it isn't installed in a standard place (e.g., /usr or -/usr/local), you'll need to tell configure where to find it with the ---with-wx-prefix=PREFIX option, for example:: - - ./configure --with-wx-prefix=/home/mylogin/wx - -Finally, if you don't want to build the graphical interface, you -can either (a) simply not install wxWidgets, or (b) pass the argument ---disable-gui to the configure step, for example, :: - - ./configure --disable-gui - -This will just build the command-line tools, and will not require -a wxWidgets installation. - - -For Windows users ------------------ - -For Windows users wanting to compile Gambit on their own, you'll need -to use either the Cygwin or MinGW environments. We do compilation and -testing of Gambit on Windows using MinGW. - - -For OS X users --------------- - -For building the command-line tools only, one should follow the -instructions for Un*x/Linux platforms above. - -.. dropdown:: Manual macOS Build Instructions +.. dropdown:: Build macOS application bundle :class-container: sd-border-0 - 2. **Build and install Gambit:** - - Navigate back to the Gambit source directory and run: - - .. code-block:: bash - - aclocal - automake --add-missing - autoconf - ./configure - make - sudo make install - - 3. **Create macOS application bundle:** + 1. **Create macOS application bundle:** To create a distributable DMG file: @@ -176,15 +140,10 @@ instructions for Un*x/Linux platforms above. make osx-dmg - 4. **Install the application:** + 2. **Install the application:** After creating the DMG file, open it and drag the Gambit application to your Applications folder. - - - - - .. _build-python: Building the Python extension From ca600e56fadc2c340bd78bebfc295c22fa9a8c0b Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 16:29:38 +0000 Subject: [PATCH 28/29] tidy pygambit installation instructions --- doc/developer.build.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/developer.build.rst b/doc/developer.build.rst index 980f9f604..70a9d64f8 100644 --- a/doc/developer.build.rst +++ b/doc/developer.build.rst @@ -150,11 +150,13 @@ Building the Python extension ----------------------------- The :ref:`pygambit Python package ` is in ``src/pygambit`` -in the Gambit source tree. -Building the extension follows the standard approach. -From the **root directory of the source tree** execute +in the Gambit source tree. We recommend to install `pygambit` +as part of a virtual environment rather than in the system's Python. +Use `pip` to install from the **root directory of the source tree**, optionally including the `-e` flag for an editable install: - python -m pip install . +.. code-block:: bash + + pip install -e . There is a set of test cases in `src/pygambit/tests`, which can be run using `nose2`. From ea9f0ce117f6c07d312bfacb2f057f05ad040569 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 29 Oct 2025 16:30:01 +0000 Subject: [PATCH 29/29] remove install.md --- INSTALL.md | 138 ----------------------------------------------------- 1 file changed, 138 deletions(-) delete mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 467619a82..000000000 --- a/INSTALL.md +++ /dev/null @@ -1,138 +0,0 @@ -### General information - -Gambit uses the standard autotools mechanism for configuring and building. -This should be familiar to most users of Un\*ces and MacOS X. In general, -you just need to unpack the sources, change directory to the top level -of the sources (typically of the form gambit-X.Y.Z), and do the -usual - - ./configure - make - sudo make install - -Command-line options are available to modify the configuration process; -do `./configure --help` for information. - -By default Gambit will be installed in /usr/local. You can change this -by replacing configure step with one of the form - - ./configure --prefix=/your/path/here - -NOTE: The graphical interface relies on external calls to other -programs built in this process, especially for the computation of -equilibria. It is strongly recommended that you install the Gambit -executables to a directory in your path! - - -### Building from git repository - -If you want to live on the bleeding edge, you can get the latest -version of the Gambit sources from the Gambit repository on -github.com, via: - - git clone https://github.com/gambitproject/gambit.git - cd gambit - -After this, you will need to set up the build scripts by executing: - - aclocal - automake --add-missing - autoconf - -For this, you will need to have automake, autoconf, and libtool2 -installed on your system. - -At this point, you can then continue with the configuration and build -stages as in the previous section. - -### gambit-enumpoly - -The program gambit-enumpoly does not compile on some compilers and systems. -If you encounter problems building this, you can disable compilation using -the switch `--disable-enumpoly` at the configuration step, e.g. - - ./configure --disable-enumpoly [other options here] - -There is a related issue in the issue tracker (#288); if you encounter problems -building `gambit-enumpoly` (or want to contribute towards fixing it!) please -use that issue to post information. - - -### For Windows users - -For Windows users wanting to compile Gambit on their own, you'll need -to use either the Cygwin or MinGW environments. We do compilation and -testing of Gambit on Windows using MinGW, which can be gotten from - -http://www.mingw.org - - -### For OS X users - -OS X users should being by following the Un\*x/Linux instructions above. -This will create the command-line tools, and the graphical interface -binary called `gambit`. This graphical interface binary requires an -X server to run correctly. - -For a more native OS X experience, after completing the Un*x/Linux -instructions, additionally issue the command - - make osx-bundle - -This will create a directory Gambit.app with the graphical interface -in an application bundle. This bundle can then be copied (e.g., to -`/Applications`) and used like any other OS X application. - -wxWidgets is available, for example, via Homebrew on Mac OS X. -If you build wxWidgets yourself (see below), -be sure to tell the `./configure` step where to find the version you built -by using the `--with-wx-prefix parameter`. For example, if you install -wxWidgets into `/usr/local` (the default when you build it), configure -Gambit with - - ./configure --with-wx-prefix=/usr/local - - -### The graphical interface and wxWidgets - -Gambit requires wxWidgets version 3.1.5 or higher for the -graphical interface. See their website at - -http://www.wxwidgets.org - -to download this if you need it. Packages of this should be available -for most Un\*x users through their package managers (apt or rpm). Note -that you'll need the appropriate -dev package for wxWidgets to get the -header files needed to build Gambit. - -Un\*x users, please note that Gambit only supports the GTK port of wxWidgets. - -If wxWidgets it isn't installed in a standard place (e.g., `/usr` or -`/usr/local`), you'll need to tell configure where to find it with the -`--with-wx-prefix=PREFIX` option, for example: - - ./configure --with-wx-prefix=/home/mylogin/wx - -Finally, if you don't want to build the graphical interface, you -can either (a) simply not install wxWidgets, or (b) pass the argument -`--disable-gui` to the configure step, for example, - - ./configure --disable-gui - -This will just build the command-line tools, and will not require -a wxWidgets installation. - - -### pygambit Python extension - -Gambit is available as a Python extension module, called `pygambit`. -`pygambit` is available via PyPi and `pip`. - -If you wish to compile the extension module on your own, then you can, -from the root directory, execute - - python setup.py build - python setup.py install - -As in general with Python, it is strongly recommended to install `pygambit` -as part of a virtual environment rather than in the system's Python.