<p align="center">
<img src="orruns/assets/logo.png" alt="ORruns Logo" width="200"/>
<br>
<em>ORruns:Next-generation Experiment Management Platform for Operations Research</em>
</p>
> 🌱 ORruns is a growing personal project. As a passionate Operations Research developer, I aim to help researchers improve their experiment efficiency. Join me in making OR experiment management easier!
<p align="center">
<a href="#quick-start">Quick Start</a> •
<a href="#why-orruns">Why ORruns</a> •
<a href="#features">Features</a> •
<a href="#community">Contribute</a>
</p>
---
## Why ORruns?
During my Operations Research studies, I frequently encountered these challenges:
- 📊 Experimental data scattered across different locations
- 🔄 Tedious experiment repetition and messy parameter management
- 📈 Repetitive visualization code writing
- 🤝 Lack of unified experiment management platform
**ORruns** was born to solve these problems! I aim to provide OR researchers with a modern, intuitive, and powerful experiment management tool.
## ✨ Features
### Elegant Experiment Management
```python
@experiment_manager(times=10, parallel=True)
def optimize_problem(tracker):
# Configure experiment parameters
tracker.log_params({
"population_size": 100,
"generations": 1000
})
# Run optimization
result = optimize()
# Track results automatically
tracker.log_metrics({
"pareto_front_size": len(result.pareto_front),
"hypervolume": result.hypervolume
})
tracker.log_artifact("pareto_front.png", plt.gcf())
return result
```
### Intuitive Web Interface
<p align="center">
<img src="orruns/assets/web.png" alt="Dashboard Screenshot" width="600"/>
</p>
## 🚀 Vision
```bash
pip install orruns
```
Check out our [Quick Start Guide](https://orruns.readthedocs.io) to begin your first experiment!
## 🚀 Making Operations Research Better
We believe that the Operations Research community deserves modern and open tooling ecosystems like those in the machine learning community. ORruns is not just a tool, but a vision - let's together:
- 🌟 Build an open, active Operations Research community
- 🔧 Create better experiment management tools
- 📚 Share knowledge and best practices
- 🤝 Facilitate academic exchange
## 💡 Get Involved
> "Good tools make research twice as efficient. Join me in making OR experiment management better!"
### 🌱 Growing Together
As a personal project:
- Every suggestion is carefully considered
- You can influence core feature design
- You'll witness and shape the project's growth
## 🎯 Roadmap
Exciting features planned for the future:
- 📊 **Enhanced Analytics** (v0.2.0)
- Dynamic Pareto Front Visualization
- Advanced Statistical Analysis Tools
- Experiment Comparison System
- 🛠️ **Improved User Experience** (v0.3.0)
- Experiment Backup and Recovery
- Publication-Ready Results Export
- Powerful Command Line Tools
> Check out the complete [roadmap document](ROADMAP.md) for more details and future plans!
## 📄 License
ORruns is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [LICENSE](LICENSE) file for details.
## 🌟 Support & Contact
---
<a href="https://www.buymeacoffee.com/your_username" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
## 🌟 Join the Community
- 💬 [Join Discussions](https://github.com/lengff123/ORruns/discussions)
- 🐛 [Report Issues](https://github.com/lengff123/ORruns/issues)
- 📫 [Mailing List](mailto:your-email@example.com)
<p align="center">
<em>By Operations Researchers, For Operations Researchers</em>
<br>
<br>
If this project helps you, please consider giving it a ⭐️
</p>
<a href="https://github.com/lengff123/ORruns/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lengff123/ORruns" />
</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/lengff123/ORruns",
"name": "orruns",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "operations research, optimization, experiment tracking, scientific computing, mathematical optimization, research tools, experiment management, reproducible research",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/ac/2abd824d76008d919bdbdb3e88888df125d12e894b95b12ca47c96976cdd/orruns-0.1.5.tar.gz",
"platform": "any",
"description": "\r\n\r\n<p align=\"center\">\r\n <img src=\"orruns/assets/logo.png\" alt=\"ORruns Logo\" width=\"200\"/>\r\n <br>\r\n <em>ORruns:Next-generation Experiment Management Platform for Operations Research</em>\r\n</p>\r\n\r\n> \ud83c\udf31 ORruns is a growing personal project. As a passionate Operations Research developer, I aim to help researchers improve their experiment efficiency. Join me in making OR experiment management easier!\r\n\r\n<p align=\"center\">\r\n <a href=\"#quick-start\">Quick Start</a> \u2022\r\n <a href=\"#why-orruns\">Why ORruns</a> \u2022\r\n <a href=\"#features\">Features</a> \u2022\r\n <a href=\"#community\">Contribute</a>\r\n</p>\r\n\r\n---\r\n\r\n## Why ORruns?\r\n\r\nDuring my Operations Research studies, I frequently encountered these challenges:\r\n\r\n- \ud83d\udcca Experimental data scattered across different locations\r\n- \ud83d\udd04 Tedious experiment repetition and messy parameter management\r\n- \ud83d\udcc8 Repetitive visualization code writing\r\n- \ud83e\udd1d Lack of unified experiment management platform\r\n\r\n**ORruns** was born to solve these problems! I aim to provide OR researchers with a modern, intuitive, and powerful experiment management tool.\r\n\r\n## \u2728 Features\r\n\r\n### Elegant Experiment Management\r\n\r\n```python\r\n@experiment_manager(times=10, parallel=True)\r\ndef optimize_problem(tracker):\r\n # Configure experiment parameters\r\n tracker.log_params({\r\n \"population_size\": 100,\r\n \"generations\": 1000\r\n })\r\n \r\n # Run optimization\r\n result = optimize()\r\n \r\n # Track results automatically\r\n tracker.log_metrics({\r\n \"pareto_front_size\": len(result.pareto_front),\r\n \"hypervolume\": result.hypervolume\r\n })\r\n tracker.log_artifact(\"pareto_front.png\", plt.gcf())\r\n \r\n return result\r\n```\r\n\r\n### Intuitive Web Interface\r\n<p align=\"center\">\r\n <img src=\"orruns/assets/web.png\" alt=\"Dashboard Screenshot\" width=\"600\"/>\r\n</p>\r\n\r\n## \ud83d\ude80 Vision\r\n\r\n```bash\r\npip install orruns\r\n```\r\n\r\nCheck out our [Quick Start Guide](https://orruns.readthedocs.io) to begin your first experiment!\r\n\r\n\r\n\r\n## \ud83d\ude80 Making Operations Research Better\r\n\r\nWe believe that the Operations Research community deserves modern and open tooling ecosystems like those in the machine learning community. ORruns is not just a tool, but a vision - let's together:\r\n\r\n- \ud83c\udf1f Build an open, active Operations Research community\r\n- \ud83d\udd27 Create better experiment management tools\r\n- \ud83d\udcda Share knowledge and best practices\r\n- \ud83e\udd1d Facilitate academic exchange\r\n\r\n## \ud83d\udca1 Get Involved\r\n\r\n> \"Good tools make research twice as efficient. Join me in making OR experiment management better!\"\r\n\r\n### \ud83c\udf31 Growing Together\r\n\r\nAs a personal project:\r\n- Every suggestion is carefully considered\r\n- You can influence core feature design\r\n- You'll witness and shape the project's growth\r\n\r\n## \ud83c\udfaf Roadmap\r\n\r\nExciting features planned for the future:\r\n\r\n- \ud83d\udcca **Enhanced Analytics** (v0.2.0)\r\n - Dynamic Pareto Front Visualization\r\n - Advanced Statistical Analysis Tools\r\n - Experiment Comparison System\r\n\r\n- \ud83d\udee0\ufe0f **Improved User Experience** (v0.3.0)\r\n - Experiment Backup and Recovery\r\n - Publication-Ready Results Export\r\n - Powerful Command Line Tools\r\n\r\n> Check out the complete [roadmap document](ROADMAP.md) for more details and future plans!\r\n\r\n\r\n## \ud83d\udcc4 License\r\n\r\nORruns is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83c\udf1f Support & Contact\r\n\r\n---\r\n<a href=\"https://www.buymeacoffee.com/your_username\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" ></a>\r\n\r\n\r\n## \ud83c\udf1f Join the Community\r\n\r\n- \ud83d\udcac [Join Discussions](https://github.com/lengff123/ORruns/discussions)\r\n- \ud83d\udc1b [Report Issues](https://github.com/lengff123/ORruns/issues)\r\n- \ud83d\udceb [Mailing List](mailto:your-email@example.com)\r\n\r\n\r\n\r\n\r\n<p align=\"center\">\r\n <em>By Operations Researchers, For Operations Researchers</em>\r\n <br>\r\n <br>\r\n If this project helps you, please consider giving it a \u2b50\ufe0f\r\n</p>\r\n\r\n<a href=\"https://github.com/lengff123/ORruns/graphs/contributors\">\r\n <img src=\"https://contrib.rocks/image?repo=lengff123/ORruns\" />\r\n</a>\r\n",
"bugtrack_url": null,
"license": "GNU Affero General Public License v3",
"summary": "Next-generation Experiment Management Platform for Operations Research",
"version": "0.1.5",
"project_urls": {
"Bug Tracker": "https://github.com/lengff123/ORruns/issues",
"Documentation": "https://orruns.readthedocs.io",
"Homepage": "https://github.com/lengff123/ORruns",
"Source Code": "https://github.com/lengff123/ORruns"
},
"split_keywords": [
"operations research",
" optimization",
" experiment tracking",
" scientific computing",
" mathematical optimization",
" research tools",
" experiment management",
" reproducible research"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "177b6ca591795889f272b978949dcd1643b64facd43e8edadb125d7a321120c6",
"md5": "e0e8b2acfe661756d8c7d1e21049cf8c",
"sha256": "705e3afb3e59a58f67ee65b80bc6c207410f42cf04ab526b8283d036369a768c"
},
"downloads": -1,
"filename": "orruns-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0e8b2acfe661756d8c7d1e21049cf8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 47216,
"upload_time": "2024-12-07T15:20:41",
"upload_time_iso_8601": "2024-12-07T15:20:41.020070Z",
"url": "https://files.pythonhosted.org/packages/17/7b/6ca591795889f272b978949dcd1643b64facd43e8edadb125d7a321120c6/orruns-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95ac2abd824d76008d919bdbdb3e88888df125d12e894b95b12ca47c96976cdd",
"md5": "e9b0283abafcd2434dface3b121cf492",
"sha256": "aef49e3193f7311868134bb0fddf5b88a436aa0f7b8eb0aef2284a484aa391fc"
},
"downloads": -1,
"filename": "orruns-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "e9b0283abafcd2434dface3b121cf492",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 42663,
"upload_time": "2024-12-07T15:20:43",
"upload_time_iso_8601": "2024-12-07T15:20:43.330405Z",
"url": "https://files.pythonhosted.org/packages/95/ac/2abd824d76008d919bdbdb3e88888df125d12e894b95b12ca47c96976cdd/orruns-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-07 15:20:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lengff123",
"github_project": "ORruns",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "dash",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5.0.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.19.0"
]
]
},
{
"name": "mkdocs",
"specs": [
[
">=",
"1.4.2"
]
]
},
{
"name": "mkdocs-material",
"specs": [
[
">=",
"9.0.0"
]
]
},
{
"name": "pymdown-extensions",
"specs": [
[
">=",
"9.0"
]
]
},
{
"name": "mkdocs",
"specs": [
[
">=",
"1.4.2"
]
]
},
{
"name": "mkdocs-material",
"specs": [
[
">=",
"9.0.0"
]
]
},
{
"name": "pymdown-extensions",
"specs": [
[
">=",
"9.0"
]
]
},
{
"name": "dash",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5.0.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.19.0"
]
]
}
],
"lcname": "orruns"
}
JSON
