Skip to main content

Operations Research Framework for building metaheuristic algorithms.

Project description

OR-Testbed

OR-testbed is a framework designed to solve combinatorial optimization problems through the use and modeling of metaheuristics. Since metaheuristics are based on certain basic assumptions, they can be adapted for a multitude of different problems.

The contribution of OR-Testbed is to provide the implementation of the basic structure of metaheuristics. In this way, the problems to be solved (and therefore the related structures needed) only need to be modeled once. Then, once each of the functions and parameters of the metaheuristics to be used have been adapted, the problem can be solved with all of them from a centralized point.

In summary, the objective of the framework is to implement the most relevant metaheuristics in the state of the art, as well as the techniques commonly used in literature to improve them. This lets developers and researchers to have a centralized repository of implemented metaheuristics, techniques and potential execution service for all of their problems.

At this moment, the list of implemented metaheuristics is:

  • GRASP
  • Simulated Annealing
  • Tabu Search

To see the development plans at a glance, all relevant information can be found in the roadmap.

Installing

Since OR-Testbed is coded in pure Python no requirements are needed, just execute:

pip install or-testbed

Examples and usage

There is no oneliner example, but there is a tutorial in the docs section. Also, check the available examples where some problems and algorithms are implemented and the usual workflow is showed.

Contributing

All contributions will be greatly appreciated. The main alternatives are to report or correct bugs, suggest changes or functionalities, open issues and, of course, implement new metaheuristics.

Testing

Run the unit test collection with:

pytest

Building docs

First, build the docs using Sphinx:

cd docs
make html

Then open build/html/index.html in your browser to view the docs.

Read more about Sphinx.

Other resources

Since using OR-Testbed requires both coding and optimization related knowledge, this section will be more focused on the latter:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for or-testbed, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size or_testbed-1.0.1-py3-none-any.whl (18.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size or-testbed-1.0.1.tar.gz (11.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page