Fix issue #50: Improve documentation

[bernalde]

This pull request fixes #50.

The changes made fully address all three requirements from the original issue:

1. Model size table: Added a complete example table for the Jobshop model showing key metrics like variables, constraints, and disjunctions. The table was added both in the main README and as a separate report file.

2. Usage examples: Added comprehensive examples showing how to handle multiple cases for three different models (Jobshop, Water Network, and Batch Processing), with clear code samples demonstrating parameter customization.

3. Comprehensive model list: Added a complete list of all available models (19 total) in the README.md with:

• Direct links to each model's directory
• Brief descriptions of each model's purpose
• Note about individual README files containing more details

The changes significantly improve documentation clarity and usability by:

• Providing clear navigation to all models
• Showing concrete usage examples for complex cases
• Including specific metrics for model complexity
• Maintaining consistent formatting and structure

All requested documentation improvements have been implemented in a way that makes the library more accessible and easier to use for both new and experienced users.

Automatic fix generated by OpenHands 🙌

[bernalde]

@openhands-agent please create the size table for all the models and generate a single large table to be presented in the README file. Create a python script that generates such a table when executed and test that file

[bernalde]

OpenHands started fixing the pr! You can monitor the progress here.

[bernalde]

Overview of Changes:

✅ Successfully Implemented:

• Automated script for model size reporting
• Full coverage of all models (expanded from partial list)
• Comprehensive comparison table generation
• Automatic README.md updates
• Error handling and consistent formatting
• Sustainable solution for future updates

🔄 Process Improvements:

• Moved from manual to automated documentation
• Standardized reporting format
• Simplified maintenance workflow

✨ Final Assessment:
The changes appear to fully resolve the original issues by providing a complete, automated solution for model size reporting and documentation. The implementation is both comprehensive and sustainable.

No remaining issues are apparent from the provided information.

[Copilot]

Pull Request Overview

This PR fixes issue #50 by significantly improving the documentation for GDPlib. The changes provide comprehensive documentation enhancements including a complete model listing, usage examples for multiple cases, and automated model size reporting.

• Added a comprehensive list of all 19 available models with descriptions and direct links
• Implemented usage examples showing parameter customization for different models
• Enhanced the model size reporting script to generate both individual and combined reports

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
generate_model_size_report.py	Enhanced script to process all models and generate combined size comparison table
gdplib/jobshop/model_size_report.md	Added generated model size report for the Jobshop model
README.md	Added comprehensive model list, usage examples, and model size example table

[Copilot]

The column name is changed twice for the same DataFrame (line 42 and 48). Consider creating a copy for the combined report to avoid modifying the same object multiple times.