SeAIPalette/README.md

# SeAI Palette集智调色板
## 0. 软件介绍
SeAI Palette集智调色板是面向集群网络的多节点智能协同路径规划软件。软件以面向对象的设计理念，采用Python语言编程，基于pyqt、pygame、pyyaml、pymunk、easydict以及ppdet等技术开发，内置3个虚拟地图和多种算法（牛耕法、内螺旋法、贪心法等，持续更新），并提供扩展接口，支持地图和算法自定义。软件安装简单，运行方便，可选参数丰富，扩展性高，非常适用于相关研究领域的工程技术人员和学生掌握学习集群智能规划方法。

集智调色板软件设计了参数输入模块、算法运行模块及信息输出模块，在不同节点数量要求的前提下划分区域方向，按区域进行算法的运行。并可以综合考虑固定节点、覆盖率、电池容量等条件下，给出运行步数、重复步数和重复率等等性能指标。

软件界面简单，易学易用，包含参数的输入选择，程序的运行，算法结果的展示等，源代码公开，算法可修改。

开发人员：王凯、于化鹏、李晶、王兆琦、李慧涛、赵志允、张乐飞、陈光

## 1. 开发环境配置
运行以下命令：
```bash
conda env create -f create_env.yaml
```
该命令会根据create_env.yaml配置文件创建一个名为`Palette`的conda虚拟环境，继续输入`conda activate Palette`即可激活该虚拟环境。


## 2. 软件运行
运行以下命令运行软件：
```python
python main_tt.py
```
## 3. 一些说明
1. 关于程序输出的说明

    程序运行结束后会在命令行输出类似于下面的结果：
    ```
    finished!!!
    Congrates! covered all the places!
    Used steps: 79
    repeat steps: 187
    repeat ratio: 187/3900=4.79%
    ```
    分别为使用的步数，重复的步数和重复率。

2. 关于渲染结果的说明

    渲染中不同移动节点负责的区域用不同颜色标记，每个区域颜色越深表示该区域被重复走的次数越多。

    为了能够让人看清最后遍历的结果，我们在程序最后加了一个循环（空循环$10^8$次）以防止渲染结果立刻消失。
    
    此外，渲染结果最后会留一格小区域没有覆盖，这个是渲染结果滞后仿真程序内核一个时间单位导致的，不会对实际测试结果造成影响。