AMPL Model Colaboratory

Website

https://colab.ampl.com

Contribution Guide

1. Use the template template/colab.ipynb as base template.

2. In the header make sure you fill the following fields:

Description: <required>

Tags: <required>, <>, <>

Notebook author: <required>

Model author: <optional>

License: <optional>

References: <optional>

3. Do not modify the initial two cells that take care of setup and jupyter notebook integration to do anything other than installing packages and instantiating the ampl_notebook. You can modify the list of modules and add more dependencies, but if you do anything else the changes may be overwritten.

4. Place your notebook inside colab.ampl.com/authors/<github_username>/.

5. Format the notebook with black, nbqa black colab.ipynb.

6. Update the badges and the index as shown below before committing.

Note: The default license for every notebook is MIT unless specified otherwise in the notebook.

Updating notebook headers & index

The following commands update the README file and the index in the documentation, as well as add any new automatically created files to the repository:

$ python scripts/index.py
$ git add docs/source/

Note that the notebook headers are patched with new badges using links to the correct locations after the notebook is published. The first two notebook cells are modified to ensure that requirements are installed and that the ampl_notebook is instantiated.

Notebooks

| Title | GitHub | Colab | Deepnote | Kaggle | Gradient | SageMaker| |--------|--------|--------|----------|--------|----------|----------| |A Party Scheduling Problem with FICO Xpress||||||| |AMPL - solve multiple models in parallel||||||| |AMPL - spreadsheet handling with amplxl||||||| |AMPL Bin Packing Problem with GCG||||||| |AMPL Capacitated p-Median Problem with GCG||||||| |AMPL Christmas Model created by ChatGPT||||||| |AMPL Development Tutorial 1/6 -- Capacitated Facility Location Problem||||||[](https://studiola