Skip to content

Commit 482f3ca

Browse files
committed
Resolve merge conflicts
2 parents 95aeacd + df534b3 commit 482f3ca

25 files changed

+2119
-1510
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ __pycache__/
22
*.py[cod]
33
*$py.class
44
cache.db*
5-
.venv
5+
*.DS_Store
6+
assets/__generated_theme.css

CODEOWNERS

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,49 @@ Workforce scheduling is a common industry problem that often becomes complex
1111
due to real-world constraints. This example demonstrates
1212
a scheduling scenario with a variety of employees and rules.
1313

14-
![Screen Image](demo.png)
14+
![Screen Image](static/demo.png)
1515

1616
## Installation
1717

18-
You can run this example without installation in cloud-based IDEs that support
19-
the [Development Containers specification](https://containers.dev/supporting)
20-
(aka "devcontainers").
18+
You can run this example without installation in cloud-based IDEs that support the
19+
[Development Containers specification](https://containers.dev/supporting) (aka "devcontainers")
20+
such as GitHub Codespaces.
2121

22-
For development environments that do not support ``devcontainers``, install
23-
requirements:
22+
For development environments that do not support `devcontainers`, install requirements:
2423

25-
pip install -r requirements.txt
24+
```bash
25+
pip install -r requirements.txt
26+
```
2627

2728
If you are cloning the repo to your local system, working in a
28-
[virtual environment](https://docs.python.org/3/library/venv.html) is
29-
recommended.
29+
[virtual environment](https://docs.python.org/3/library/venv.html) is recommended.
3030

3131
## Usage
3232

33-
Your development environment should be configured to
34-
[access Leap’s Solvers](https://docs.ocean.dwavesys.com/en/stable/overview/sapi.html).
35-
You can see information about supported IDEs and authorizing access to your
36-
Leap account [here](https://docs.dwavesys.com/docs/latest/doc_leap_dev_env.html).
33+
Your development environment should be configured to access the
34+
[Leap™ Quantum Cloud Service](https://docs.ocean.dwavesys.com/en/stable/overview/sapi.html).
35+
You can see information about supported IDEs and authorizing access to your Leap account
36+
[here](https://docs.dwavesys.com/docs/latest/doc_leap_dev_env.html).
3737

38-
To run the demo, type the ``python app.py`` command into your terminal and then open a web browser
39-
to the URL printed to the terminal.
38+
Run the following terminal command to start the Dash app:
4039

41-
Set any of the input options to configure the problem and then click the "Solve"
42-
button.
40+
```bash
41+
python app.py
42+
```
4343

44-
### Introducing the Demo
44+
Access the user interface with your browser at http://127.0.0.1:8050/.
45+
46+
The demo program opens an interface where you can configure problems and submit these problems to
47+
a solver.
48+
49+
Configuration options can be found in the [demo_configs.py](demo_configs.py) file.
50+
51+
> [!NOTE]\
52+
> If you plan on editing any files while the app is running,
53+
please run the app with the `--debug` command-line argument for live reloads and easier debugging:
54+
`python app.py --debug`
55+
56+
## Problem Description
4557

4658
The employee availability chart shows employee shift preferences and unavailable
4759
days (PTO). Requested shifts are in teal and marked with a '✓', while
@@ -58,24 +70,24 @@ In the chart, there are three different types of employees.
5870
The chart displays employee preferences and availability over two weeks. It will
5971
always display two weeks starting two Sundays from now, with one column for each day of the two week period.
6072

73+
A subset of the employees have requested full-time schedules which consists of 5 days on,
74+
2 days off, and is one of three options: Monday-Friday, Tuesday-Saturday, Sunday-Wednesday.
75+
6176
### Inputs
6277

6378
The scenario preset auto-populates all settings with scenarios of varying
6479
sizes. If 'Custom' is selected, the following settings become available:
6580

6681
- Number of employees: Schedules always include 2 managers and 1 trainee.
82+
- Number of full-time employees: The subset of the employees that have requested a 5 days on,
83+
2 days off schedule.
6784
- Max consecutive shifts: The maximum number of consecutive shifts an employee
6885
can be scheduled before a day off must be scheduled.
69-
- Min/max shifts per employee: This range determines the number of shifts an
86+
- Min/max shifts per part-time employee: This range determines the number of shifts an
7087
employee can work.
71-
- Min/max employees per shift: This range determines how many employees need
72-
to be assigned to each shift.
88+
- Forecast: This determines how many employees are needed per day.
7389
- Allow isolated days off: If unchecked, employees must be
7490
scheduled for at least two consecutive days off between work days.
75-
- Require a manager on every shift: If checked, every shift
76-
must have exactly one manager on duty to supervise.
77-
- Random seed (optional): If set with an integer, it will ensure consistency
78-
between subsequent runs of the same example.
7991

8092
### Outputs
8193

0 commit comments

Comments
 (0)