Skip to content
Snippets Groups Projects
README.md 1.55 KiB
Newer Older
sylearn's avatar
sylearn committed
# 项目名称

## 项目概述
本项目旨在...(简要描述项目的目标和主要功能)

## 目录结构
- `src/`
  - `shell_script/`
    - `main.sh`
    - `cal_0-energy.sh`
  - `dataset_process/`
    - `generate-newdata.py`
    - `get_vasp_cal_data.py`
    - `utils/`
      - `utils.py`
sylearn's avatar
sylearn committed
  - `fit/`
sylearn's avatar
sylearn committed
    - `utils/`
      - `utils.py`
- `.env`

## 安装与配置
1. **环境配置**
   - 安装所需的Python版本:`Python 3.x`
   - 安装依赖包:`pip install -r requirements.txt`

2. **环境变量**
sylearn's avatar
sylearn committed

## 使用说明
1. **数据集格式化**
   - 运行`src/format_dataset/0-get_energy_data_all.py`以获取和格式化能量数据。

2. **材料筛选**
   - 运行`src/filter_material/a-filter_data.py`以筛选材料数据。
   - 运行`src/filter_material/b1_relax_structure.py`以放松结构。
   - 运行`src/filter_material/b2_random_sample.py`以随机采样。
   - 运行`src/filter_material/b3_sample_structure.py`以采样结构。

3. **拟合**
   - 运行`src/fit/3-fit-group-EPS.py`以进行拟合。
   - 运行`src/fit/utils/3-fit-group-EPS.py`以使用辅助函数进行拟合。

## 贡献指南
欢迎贡献代码!请遵循以下步骤:
1. Fork 本仓库。
2. 创建新的分支 (`git checkout -b feature/your-feature-name`)。
3. 提交更改 (`git commit -am 'Add some feature'`)。
4. 推送到分支 (`git push origin feature/your-feature-name`)。
5. 创建新的 Pull Request。

## 许可证
本项目采用MIT许可证。详情请参阅`LICENSE`文件。