haileyhalimj@gmail.com commited on
Commit
7d8d330
Β·
1 Parent(s): 99c7d69

Prepare for Hugging Face upload: improved code readability, excluded large files

Browse files
Files changed (2) hide show
  1. .gitignore +3 -1
  2. README.md +14 -63
.gitignore CHANGED
@@ -66,4 +66,6 @@ docs/_build/
66
  # Large files
67
  *.zip
68
  *.tar.gz
69
- *.rar
 
 
 
66
  # Large files
67
  *.zip
68
  *.tar.gz
69
+ *.rardata/real_data_excel/converted_csv/*.csv
70
+ *.csv
71
+ data/real_data_excel/converted_csv/
README.md CHANGED
@@ -1,63 +1,14 @@
1
- # Supply Roster Optimization Tool
2
-
3
- A Python-based tool for optimizing weekly supply roster scheduling using linear programming.
4
-
5
- ## Features
6
-
7
- - **Weekly optimization** with employee scheduling
8
- - **Hierarchy-aware production ordering** (prepacks β†’ subkits β†’ masters)
9
- - Support for multiple product types and shift patterns
10
- - Configurable constraints for labor costs and productivity
11
- - OR-Tools integration for optimization
12
- - Streamlit web interface for visualization and configuration
13
-
14
- ## Project Structure
15
-
16
- ```
17
- β”œβ”€β”€ src/
18
- β”‚ β”œβ”€β”€ config/ # Configuration files
19
- β”‚ β”œβ”€β”€ models/ # Optimization models
20
- β”‚ β”œβ”€β”€ utils/ # Utility functions
21
- β”‚ └── visualization/ # Web interfaces
22
- β”œβ”€β”€ data/ # Data files (not tracked)
23
- β”œβ”€β”€ results/ # Output files (not tracked)
24
- β”œβ”€β”€ requirements.txt # Python dependencies
25
- β”œβ”€β”€ pyproject.toml # Project configuration
26
- └── README.md
27
-
28
- ```
29
-
30
- ## Setup
31
-
32
- 1. Create virtual environment:
33
- ```bash
34
- python -m venv venv
35
- source venv/bin/activate # On Windows: venv\Scripts\activate
36
- ```
37
-
38
- 2. Install dependencies:
39
- ```bash
40
- pip install -r requirements.txt
41
- ```
42
-
43
- ## Usage
44
-
45
- ```bash
46
- # Start the web interface (main entry point)
47
- streamlit run app.py
48
-
49
- # Alternative: Run configuration page directly
50
- streamlit run config_page.py
51
- ```
52
-
53
- ## Dependencies
54
-
55
- - Python >= 3.8
56
- - OR-Tools >= 9.4.0
57
- - Pandas >= 1.3.0
58
- - Streamlit >= 1.18.0
59
- - Plotly >= 5.8.0
60
-
61
- ## License
62
-
63
- MIT License
 
1
+ ---
2
+ title: Supply Roster Optimization
3
+ emoji: πŸ“Š
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: streamlit
7
+ sdk_version: "1.28.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # Supply Roster Optimization
13
+
14
+ This is a Streamlit application for optimizing supply roster management with improved code readability.