Metadata-Version: 2.1
Name: orruns
Version: 0.1.4
Summary: Next-generation Experiment Management Platform for Operations Research
Home-page: https://github.com/lengff123/ORruns
License: GNU Affero General Public License v3
Project-URL: Bug Tracker, https://github.com/lengff123/ORruns/issues
Project-URL: Documentation, https://orruns.readthedocs.io
Project-URL: Source Code, https://github.com/lengff123/ORruns
Keywords: operations research,optimization,experiment tracking,scientific computing,mathematical optimization,research tools,experiment management,reproducible research
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Environment :: Console
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=7.0
Requires-Dist: cloudpickle>=1.6.0
Requires-Dist: matplotlib>=3.3.0
Requires-Dist: numpy>=1.19.0
Requires-Dist: pandas>=1.0.0
Requires-Dist: tabulate>=0.8.0
Requires-Dist: dash
Requires-Dist: dash-bootstrap-components
Requires-Dist: plotly
Requires-Dist: flask
Provides-Extra: dev
Requires-Dist: pytest>=6.0.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: isort>=5.0.0; extra == "dev"
Requires-Dist: mypy>=0.900; extra == "dev"
Requires-Dist: pylint>=2.0.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"



<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>

