Git Product home page Git Product logo

gams_stub's Introduction

A GAMS Project Stub

This is a stub for a new GAMS project. It contains the following features:

  1. Automatic documentation from reStructuredText and \LaTeX comments in the GAMS file(s)
  2. Writing comments to the GAMS log file during a GAMS run
  3. Auxiliary function to write the computation time (since start of the GAMS run) to the log file

Dependencies

This stub depends on

  1. Python
  2. Sphinx

Making a New Project

Choose a project name and run the following commands replacing <project name> with your choice:

git clone https://github.com/iiasa/gams_stub.git <project name>
cd <project name>
./make_proj.sh <project name>

You should now have a fresh new repository with your project ready to go. You can sync it with Github via:

git remote add origin [email protected]:<user name>/<project name>
git push origin master

Documentation

On *Nix Platforms

After you install the project locally, you can generate documentation by:

cd doc
make html

You can serve the documentation locally via:

make serve

You can then view the docs at http://localhost:8000/build/html/

On Windows

For Windows users, Anaconda is a good way to get started with Python, and Sphynx is already included.

Follow the above instructions replacing make with ./make.bat.

gams_stub's People

Contributors

gidden avatar danielhuppmann avatar

Watchers

James Cloos avatar Yu Jiang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.