NRP-solver 开源项目使用教程

NRP-solver 开源项目使用教程

NRP-solver 项目地址: https://gitcode.com/gh_mirrors/nr/NRP-solver

1. 项目目录结构及介绍

NRP-solver 是一个用于解决护士排班问题（Nurse Rostering Problem, NRP）的开源解决方案。以下是主要的目录结构和它们的简介：

NRP-solver/
├── src/
│   ├── main.py
│   ├── utils.py
│   └── ...
├── models/
│   ├── schedule_model.py
│   └── ...
├── initial_solutions/
│   ├── initial_schedule.py
│   └── ...
├── output/
│   └── ...
├── CMakeLists.txt
├── LICENSE
└── README.md

目录结构介绍

• src/: 包含核心源代码，这里的 .py 文件实现了算法和主要逻辑。
• models/: 存放数据模型文件，通常是以 .py 为扩展名，这些文件定义了具体的排班需求。
• initial_solutions/: 提供了一些初始解的示例，即排班方案的起始点。
• output/: 项目执行后，可能生成的结果或报告会被存放在这里。
• CMakeLists.txt: CMake 配置文件，用于构建整个项目。
• LICENSE: 许可证文件，声明该项目遵循 Apache-2.0 许可证。
• README.md: 项目说明文件，包含项目的简介和使用说明。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/ 目录下，主要负责初始化项目并启动排班算法的执行。以下是启动文件的介绍：

src/main.py

main.py 是项目的入口文件，负责加载配置、初始化数据模型、调用排班算法并输出结果。以下是 main.py 的主要功能：

• 加载配置: 从配置文件中读取排班需求和参数。
• 初始化数据模型: 根据配置文件初始化排班模型。
• 调用排班算法: 调用 utils.py 中的排班算法函数。
• 输出结果: 将排班结果保存到 output/ 目录下。

src/utils.py

utils.py 包含了一些辅助函数，用于支持排班算法的实现。以下是 utils.py 的主要功能：

• 排班算法: 实现了具体的排班算法逻辑。
• 数据处理: 提供了一些数据处理函数，用于处理输入数据和生成输出数据。

3. 项目的配置文件介绍

项目的配置文件通常用于定义排班需求和参数，以下是配置文件的介绍：

config.json

config.json 是项目的配置文件，用于定义排班需求和参数。以下是 config.json 的主要内容：

{
  "schedule_requirements": {
    "nurses": 10,
    "shifts": ["morning", "afternoon", "night"],
    "days": 7
  },
  "constraints": {
    "max_consecutive_shifts": 3,
    "min_rest_days": 1
  }
}

配置文件介绍

• schedule_requirements: 定义了排班的基本需求，包括护士数量、班次类型和排班天数。
• constraints: 定义了排班的约束条件，如最大连续工作天数和最小休息天数。

通过以上配置文件，项目可以根据具体的排班需求和约束条件生成合理的排班方案。

NRP-solver 项目地址: https://gitcode.com/gh_mirrors/nr/NRP-solver