Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 5.03 KB

README.md

File metadata and controls

84 lines (57 loc) · 5.03 KB
Raw

GAMS Studio

GAMS Studio is the official development environment of the General Algebraic Modeling System (GAMS). For further information about GAMS please visit the official GAMS website, the GAMS documentation or the GAMS Forum, where Studio also has its own FAQ section.

How to install

To install GAMS Studio on your system follow the steps for your platform. On Linux and Windows Studio is installed into the GAMS system directory (<GAMS SysDir>), which is the installation location of GAMS. Only on macOS Studio will be installed in the Application directory.

Linux

  1. Download the AppImage
  2. Copy the AppImage to the <GAMS SysDir>\studio
  3. Make it runnable via chmod +x <GAMS SysDir>\studio\*.AppImage
  4. Run Studio via the shell or via your file manager

macOS

  1. Download the DMG for your macOS (Intel - x86 or Apple Silicon - ARM)
  2. Double click on the dmg to open it. A new window should open and show a GAMS icon.
  3. Move the Studio directory (via dragging and dropping the icon) to the Applications directory within your Finder window. Replace any existing old version, if a message is shown.
  4. Go to the Application directory or go to the Launchpad and open the "GAMS Studio"

Windows

  1. Download the zip file and extract it
  2. Copy the new directory (studio) to the <GAMS SysDir> to replace the previous Studio version or rename the studio directory before copying.
  3. Run Studio via double clicking on the studio.exe

How to build

1. Download and install Qt

The recommended way to get Qt is via its official Qt online installer. If you are interested in the Qt sources you can download them through the installer or build Qt from scratch by following the Qt documentation. Alternatively, you can get and build Qt from the official Qt GitHub mirror.

2. Download and install GAMS

GAMS Studio requires the GAMS low-level APIs. All those files are provided by the GAMS distribution packages, which are available for all major platforms. The installation package for your platform can be obtained from the GAMS download page. After downloading the package please follow the latest GAMS installation instructions.

Note By default GAMS will run in demo mode. Please check the download page for further details.

3. Get the GAMS Studio source code

Download the GAMS Studio sources from GitHub (via git or as zip archive). All information about the usage of this program can be found within the GAMS Documentation.

4. Building the GAMS Studio project

Start Qt Creator, open the project file gams-studio.pro and click Build -> Run qmake. This generates the file gamsinclude.pri that defines the default location of the GAMS installation location. The path within the gamsinclude.pri may have to be updated to the correct GAMS installation location on your system.

On Windows the file contains:

GAMS_DISTRIB=C:/GAMS/35
GAMS_DISTRIB_C_API=$$GAMS_DISTRIB/apifiles/C/api
GAMS_DISTRIB_CPP_API=$$GAMS_DISTRIB/apifiles/C++/api

On Unix it will look like:

GAMS_DISTRIB=$$(HOME)/gams/gams35.0_linux_x64_64_sfx
GAMS_DISTRIB_C_API=$$GAMS_DISTRIB/apifiles/C/api
GAMS_DISTRIB_CPP_API=$$GAMS_DISTRIB/apifiles/C++/api

Then perform a Build All operation (Build -> Build All) to build the project. Finally, the GAMS Studio can be executed by triggering Run button or pressing Ctrl + R.

Contributing

Your contributions to the GAMS Studio project are highly appreciated! Depending on your type of improvement you may want to create an issue or fork GAMS Studio and open a pull request when your changes are ready.

Before you request a review of your changes please make sure that you used the latest GAMS release for development and that your code is following the Qt Coding Style.

Dependencies and Licenses

Dependency License Description
Qt 6 LGPL Qt Licensing. The Qt 6 everywhere package (source) can be downloaded from GAMS or directly from https://www.qt.io/download, where installers are provided as well.
dtoaLoc License
engineapi MIT Owned by GAMS and can be used in other projects.
yaml-cpp MIT The project can be found at https://github.com/jbeder/yaml-cpp