Help on using GAMS Documentation and Model Libraries

The followings are guidelines on how to use our GAMS Documentation and Model Libraries.

Navigating and Viewing the Contents

Click on Documentation in the top left area of the page to start browsing topics from the main documentation page or click on Model Libaries in the top page area to start browsing from the main model libraries page.

  • To browse Documentation
    • Click on Documentation. Each Documentation page have a table of contents on the left hand side of the page.
    • To have the content displayed in the right hand side area, click on a topic entry in the table of contents.
    • To either expand or hide all immediate subtopics of the topic, click on the blue arrow next to the topic name in the table of contents.
  • To browse Model Libaries
    • Click on Model Libaries and select the model library of interest. Each model Library page lists all available models in a table.
    • To select the number of entries to be showed per page, select the number from a drop-down list on the top left of the table.
    • To filter the entries currently displaying in the page, type in a keyword into search box on the top right of the table.
    • To sort the entries alphabetically in either ascending order or decending order, click on the arrows in a column header of the table.

Use the Back and Forward functions in the browser to navigate the history of viewed topics, and click on Documentation or on Model Libaries to restart browsing topics from the main pages.

Searching for Contents

To search documentation or search model libraries, click on search in the top right area of the page. Depeding on the version you are using,

  • the online search, powered by Google custom search, allows Google tips and tricks to search the online version of GAMS Documentation.
    • By default, all sections will be searched. To the narrow down the scope of your search, select a tab with a section name.
  • the offline search, either search documentation or search model libraries. Follows the following search expression rules to search the offline contents:
    • By default, all sections will be searched. To the narrow down the scope of your search, select from the drop-down list a section name.
    • The search engine ignores character case. For example:
      GAMS
      returns topics that contain gams, Gams, GaMs, and GAMS.
    • The search engine does "fuzzy" searches and word stemming. If you enter
      create
      it will return hits on topics that contain creates, creating, creator, and so on.
    • There is an implied AND between all search terms. In other words, topics that contain all the search terms will be returned. For example:
      objective function 
      returns topics that contain the word objective and the word function, but does not return topics that contain only one of these words.
    • The following stop words are common English words which will be ignored (not searched for) if they appear in the search expression:
      a, able, about, across, after, all, almost, also, am, among, an, and, any, are, as, at, be, because, been, but, by, can, cannot, could,  dear, did, do, does, either, else, ever, every, for, from, get, got, had, has, have, he, her, hers, him, his, how, however, i, if, in, into, is, it, its, just, least, let, like, likely, may, me, might, most, must, my, neither, no, nor, not, of, off, often, on, only, or, other, our, own, rather, said, say, says, she, should, since, so, some, than, that, the, their, them, then, there, these, they, this, tis, to, too, twas, us, wants, was, we, were, what, when, where, which, while, who, whom, why, will, with, would, yet, you, your

To search within one document page for a specific word or phrase, use Find... (for example, CTRL+F) function in the browser.

Browsing Index

Index page contains a list of interesting keywords extracted from the documentation, providing a convenient way to access the contents directly using the known keyword. Only GAMS Documentation pages are indexed and not all sections contain an index, there is no index for Model Libraries. Click on Index on the top right area of each document page to start browsing index. Type in a keyword into a keyword box to filter the list of all keywords. Check case sensitive box to do case sensitive filtering or check Match whole word box to match the whole word.