-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial implementation of PyORlib #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
idapena
added
documentation
Improvements or additions to documentation
github actions
Pull requests that update Github actions code
dependencies
Pull requests that update a dependency
feature
New feature or request
labels
Mar 2, 2024
mdapena
approved these changes
Mar 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
dependencies
Pull requests that update a dependency
documentation
Improvements or additions to documentation
feature
New feature or request
github actions
Pull requests that update Github actions code
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial Checks
Description
This pull request introduces the initial implementation of PyORlib, a powerful Python library for operations research and optimization. PyORlib provides a set of abstractions to easily define, solve, and interact with mathematical models in a standardized manner across different optimization packages. It serves as a user-friendly and powerful platform for students, researchers, and practitioners to explore optimization concepts, experiment with algorithms, and expand their knowledge.
Implementation Details
The first implementation includes all the core functionalities of the package, encompassing built-in optimization package integrations, algebraic modeling, validators, and more.
Testing and Coverage
This release includes a test suite that verifies the correctness of the package implementation. It also integrates code coverage, achieving 100% test coverage. The tests are configured to run automatically via GitHub Actions on both push and pull requests to the master branch.
Formatter and Lint Configuration
A formatter and lint configuration have been added to the project. This ensures consistent code style, maintainability, and adherence to the established coding standards defined in the project documentation.
Documentation
Additionally, this release includes comprehensive documentation for the package. The documentation covers the main page, a detailed getting started guide, examples, API reference, and release notes.