From cda8a6b9ae45bdfa3c82962f568efcc6ccded806 Mon Sep 17 00:00:00 2001 From: Koen van der Blom Date: Tue, 7 Jul 2026 15:49:14 +0200 Subject: [PATCH 1/4] Update OPL readme to clarify better how to add problems + how to contribute to the project. --- README.md | 41 ++++++++++++++++++----------------------- 1 file changed, 18 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d63f9db..f027116 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,22 @@ # OPL - Optimisation problem library -Collection of optimisation problems and benchmark suites with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. - -## Contributing -Contributions and corrections are very welcome, through pull requests, issue reporting, or email. - -If you want to provide a problem/suite/generator, you can also do so via this [form](https://docs.google.com/forms/d/e/1FAIpQLSehQp24AuFAH2j9jizDhq8K_BYgNGMKXWTMu6s-2RwEJrK59Q/viewform?usp=sharing&ouid=107462254722022409950). - -### Details to provide -It is often far easier for the creator of a problem/suite/generator, or someone working with it, to provide details about it than for someone new to it. Currently, the following specific details are being collected: -- Name of the problem/suite/generator -- Whether it concerns a suite, generator, or single problem -- Number of objectives (or available range) -- Number of variable dimensions (or available range) -- Type of variables (can be multiple) -- Be as specific as possible (e.g., integer/binary/categorical, rather than 'discrete') -- Whether the search space is subject to constraints or not (other than boundary constraints) -- Whether the problem(s) is/are dynamic or not -- Whether the problem(s) is/are noisy or not -- Whether the objective space is multimodal or not -- Whether objectives can be evaluated for multiple fidelities or not -- Any other info you feel is important -- A reference to a scientific publication on the problem/suite/generator (if available) -- A reference to a source code implementation of the problem/suite/generator (if available) +The optimisation problem library aims to make optimsation problems easier to find by collecting problems, benchmark suites and generators, annotated with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. All collected problems are available through a searchable [website](https://openoptimizationorg.github.io/OPL/). + +## How to add problems +Contributions and corrections are very welcome, through pull requests, issue reporting, or [email](contact). + +If you want to provide a problem/suite/generator, you can also do so via this [form](https://docs.google.com/forms/d/e/1FAIpQLSehQp24AuFAH2j9jizDhq8K_BYgNGMKXWTMu6s-2RwEJrK59Q/viewform?usp=sharing&ouid=107462254722022409950). + +## How to contribute to the project +Want to get involved to make OPL even better? Any help is welcome! + +We need help to +- Extending the OPL infrastructure to make it easier to add, find, edit, extend, aggregate problems +- Advertise OPL +- and, of course, add more problems! + +Finally, you are also very welcome to propose your own ideas to make OPL better, and work on those. + +To get invovled, just send an [email](#contact), or talk to any of us. ## How to cite @@ -33,7 +29,6 @@ It is often far easier for the creator of a problem/suite/generator, or someone } ``` - ## Contact koen.van.der.blom@cwi.nl From 5859774a9b9925f41d24a6f051ed9b07333c3ea4 Mon Sep 17 00:00:00 2001 From: Koen van der Blom Date: Tue, 7 Jul 2026 15:51:42 +0200 Subject: [PATCH 2/4] Update references to email to make clear it points to another section fo the README. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f027116..652d2a9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The optimisation problem library aims to make optimsation problems easier to find by collecting problems, benchmark suites and generators, annotated with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. All collected problems are available through a searchable [website](https://openoptimizationorg.github.io/OPL/). ## How to add problems -Contributions and corrections are very welcome, through pull requests, issue reporting, or [email](contact). +Contributions and corrections are very welcome, through pull requests, issue reporting, or email (see [contact](contact)). If you want to provide a problem/suite/generator, you can also do so via this [form](https://docs.google.com/forms/d/e/1FAIpQLSehQp24AuFAH2j9jizDhq8K_BYgNGMKXWTMu6s-2RwEJrK59Q/viewform?usp=sharing&ouid=107462254722022409950). @@ -16,7 +16,7 @@ We need help to Finally, you are also very welcome to propose your own ideas to make OPL better, and work on those. -To get invovled, just send an [email](#contact), or talk to any of us. +To get invovled, just send an email (see [contact](contact)), or talk to any of us. ## How to cite From 39b1a494e330f66164c8d76865df8a36c1056f75 Mon Sep 17 00:00:00 2001 From: Koen van der Blom Date: Wed, 8 Jul 2026 11:14:40 +0200 Subject: [PATCH 3/4] Add references to the other libraries (OAL + OFL), and the overview page. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 652d2a9..cf2d177 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # OPL - Optimisation problem library The optimisation problem library aims to make optimsation problems easier to find by collecting problems, benchmark suites and generators, annotated with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. All collected problems are available through a searchable [website](https://openoptimizationorg.github.io/OPL/). +## Other libraries: Algorithms and features +In addition to the problem collection of OPL, we are also working on libraries for optimisation algorithms and features: +- OAL - Optimisation algorithm library: [website](https://openoptimizationorg.github.io/OAL/), [github](https://github.com/OpenOptimizationOrg/OAL/) +- OFL - Optimisation feature library: [website](https://openoptimizationorg.github.io/OFL/), [github](https://github.com/OpenOptimizationOrg/OFL/) + +Finally, an overview of the different projects is available [here](https://openoptimizationorg.github.io/Overview/). + ## How to add problems Contributions and corrections are very welcome, through pull requests, issue reporting, or email (see [contact](contact)). From ff689c57014b8e7e551d14becfad9e0668a0a3c3 Mon Sep 17 00:00:00 2001 From: Koen van der Blom Date: Wed, 8 Jul 2026 11:17:05 +0200 Subject: [PATCH 4/4] Fix typos. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf2d177..84dd2ad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # OPL - Optimisation problem library -The optimisation problem library aims to make optimsation problems easier to find by collecting problems, benchmark suites and generators, annotated with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. All collected problems are available through a searchable [website](https://openoptimizationorg.github.io/OPL/). +The optimisation problem library aims to make optimisation problems easier to find by collecting problems, benchmark suites and generators, annotated with information about high level properties like the type of decision variables, number of objectives, and the presence of constraints. Where available references to papers describing the problem and implementations are included. All collected problems are available through a searchable [website](https://openoptimizationorg.github.io/OPL/). ## Other libraries: Algorithms and features In addition to the problem collection of OPL, we are also working on libraries for optimisation algorithms and features: @@ -23,7 +23,7 @@ We need help to Finally, you are also very welcome to propose your own ideas to make OPL better, and work on those. -To get invovled, just send an email (see [contact](contact)), or talk to any of us. +To get involved, just send an email (see [contact](contact)), or talk to any of us. ## How to cite