https://github.com/j3soon/nurse-scheduling
(WIP) A user-friendly web app to automate the nurse scheduling task.
https://github.com/j3soon/nurse-scheduling
employee-scheduling nurse-scheduling nurse-scheduling-problem shift-scheduling
Last synced: 2 months ago
JSON representation
(WIP) A user-friendly web app to automate the nurse scheduling task.
- Host: GitHub
- URL: https://github.com/j3soon/nurse-scheduling
- Owner: j3soon
- Created: 2023-12-21T14:11:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-09T16:08:38.000Z (3 months ago)
- Last Synced: 2025-03-09T17:19:55.917Z (3 months ago)
- Topics: employee-scheduling, nurse-scheduling, nurse-scheduling-problem, shift-scheduling
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nurse Scheduling System
[](https://github.com/j3soon/nurse-scheduling/actions/workflows/test-core.yaml)
[](https://codecov.io/github/j3soon/nurse-scheduling)
The nurse scheduling (or employee scheduling) problem is a well-known problem in the field of operations research (OR) and can be (approximately) solved efficiently by constrained optimization.
However, the constraints vary significantly across hospitals or wards. Therefore, in practice, the problem is often solved by hand or with the help of Excel, which is really time-consuming. The entire process requires several hours or even more than ten hours, depending on the problem complexity (e.g., multiple wards).
This project (Nurse Scheduling System, or 護理排班系統 in Mandarin) aims to develop a user-friendly web app to automate the nurse scheduling task.
> This project is currently a **Work in Progress**, so it may not function as intended. A preliminary version (or a POC) of a command-line interface is implemented and verified by domain experts under a multi-ward scenario at 2023/08/20. We are currently refactoring the codebase along with test cases to make it more maintainable.
## Design Philosophy
### Choice of Solver
Since I'm not an expert in operations research, I've done some research on suitable (open-source) solvers for this problem. The most popular ones seem to be [Timefold](https://github.com/TimefoldAI/timefold-solver) (previously [OptaPlanner](https://github.com/kiegroup/optaplanner)) and [Google OR-Tools](https://github.com/google/or-tools). There's also a [comparison](https://www.optaplanner.org/competitor/or-tools.html) between the two.
Google OR-Tools is chosen due to the support of Python, which is the language I'm most familiar with this kind of project.
### Choice of Input Format
We prioritize human readability and ease of editing by hand over machine parsing simplicity.
To allow quick prototyping without defining data type classes, we choose to keep the YAML input intact in memory. This requires extracting data explicitly using utility functions.
## References
- [Nurse rostering - Timefold](https://timefold.ai/docs/timefold-solver/latest/use-cases-and-examples/nurse-rostering/nurse-rostering.html)
- [A nurse scheduling problem - OR-Tools](https://developers.google.com/optimization/scheduling/employee_scheduling#a_nurse_scheduling_problem)
- Haspeslagh et al., 2010, [First International Nurse Rostering Competition 2010](https://nrpcompetition.kuleuven-kulak.be/wp-content/uploads/2020/06/nrpcompetition_description.pdf) [[website](https://nrpcompetition.kuleuven-kulak.be/)]
- Ceschia et al., 2015, [Second International Nurse Rostering Competition (INRC-II) --- Problem Description and Rules ---](https://arxiv.org/abs/1501.04177) [[website](https://mobiz.vives.be/inrc2/)]