/amplrestapi

Asynchorous AMPL REST Interface written in Python 3.6

Primary LanguagePythonMIT LicenseMIT

amplrestapi logo


Version Documentation Maintenance License: MIT

AMPLRESTAPI is a custom asynchronous REST API layer written in modern Python to solve optimization problems in AMPL.

How to run

A docker-compose.yml file is included in the repository for simplicity. To run an AMPL REST server on port localhost:9001, clone the project, open a terminal window in it and type:

docker-compose up --build

🔑 Key features

  • ✨ only needs Docker to run
  • 💪 written in idiomatic asynchronous Python 3.6 with typings support
  • ✔ easy code structure composed of multiple submodules
  • ⚠ based on the free demo version of AMPL and the CPLEX engine

❔ How to use

This project has been originally created as a University Project. A complete project report is available in docs/report.pdf. The API documentation is also available in OpenAPI 3 format in docs/api/openapi.yml. An HTML version of the API documentation is available here.

👤 Author

Alberto Schiabel

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. The code is short, throughly commented and well tested, so you should feel quite comfortable working on it. If you have any doubt or suggestion, please open an issue.

🦄 Show your support

Give a ⭐ if this project helped or inspired you!

📝 License

Built with ❤ by Alberto Schiabel.
This project is MIT licensed.

Related repositories

  • docker-ampl-python: Repository containing the Docker image upon which the current project is built on