# report-template-MMMS

**Repository Path**: yangsl306/report-template-MMMS

## Basic Information

- **Project Name**: report-template-MMMS
- **Description**: 《多尺度材料模拟与计算》课程实验报告及作业 LaTeX、Markdown 模板
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: https://gitee.com/yangsl306/report-template-MMMS
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-08
- **Last Updated**: 2024-10-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 《多尺度材料模拟与计算》课程实验报告及作业 LaTeX、Markdown 模板

- 作者：小小角色、走楼梯啊
- 创建时间：2023.10.03
- 本模板 tex 文件结构主要参考 [SJTUThesis](https://github.com/sjtug/SJTUThesis)
- 以下内容如有错误或疑问，或友好交流互动，请在该仓库中提 [Issues](https://gitee.com/yangsl306/report-template-MMMS/issues/new)
- 本模板内容较为简略，十分欢迎感兴趣、有能力的同学对其进行丰富扩展

---

## 课程实验报告提交要求

- **框架及内容需完整：框架上，一般需要有实验目的、方法、内容、结果分析、结论、参考文献等部分；内容上，需要 pdf 文档 + 完整的源码 + 数据图片等其他附件资料，请将这些资料打包压缩上传至 canvas（如 pdf 文档由 LaTeX 编写，也需提供 完整的 tex 源文件）**
- 如有同学使用 Python 编写程序，也可使用 Jupyter Notebook 的形式写程序 + 实验报告
- 如有同学会使用 LaTeX，可使用 [report-template-MMMS: 《多尺度材料模拟与计算》课程实验报告 LaTeX 模板](https://gitee.com/yangsl306/report-template-MMMS) 提供的模板，具体使用方法见 repo 中的 README.md
- 平时作业 LaTeX 模板（待完善），可使用 [report-template-MMMS: 《多尺度材料模拟与计算》课程作业 LaTeX 模板](https://gitee.com/yangsl306/report-template-MMMS/tree/homework/) ，具体使用方法见 repo 中的 README.md
- 也可使用 Markdown 撰写实验报告，其对代码的高亮支持较好，也需保证框架完整，最后转成 pdf 文档；可使用 [report-template-MMMS: 《多尺度材料模拟与计算》课程作业 Markdown 模板](https://gitee.com/yangsl306/report-template-MMMS/tree/report_markdown) 提供的模板，具体使用方法见 repo 中的 README.md
- 若使用 Word 撰写实验报告，保证框架完整即可，可参考上述的 LaTeX 模板，最后转成 pdf 文档

---

## 文档结构

```txt
├── assets
│   ├── Figures
│   ├── Icons
├── contents
│   ├── appendix.tex
│   ├── content.tex
├── main.tex
├── mmms.sty
└── refs.bib
```

- `assets/` - 文档封面、数据等图片文件（**在此添加数据图片**）
- `main.tex` - 主文件，需修改封面文字信息，如实验报告名称、姓名、学号和日期
- `mmms.sty` - mmms 宏包文件，包含文档格式设置（**基本不用修改**）
- `contents/` - 文档各部分的 `tex` 文件，如摘要、正文、附录等（**在此部分进行修改**）
  - `content.tex` - 正文部分，根据需要添加、删除内容
  - `appendix.tex` - 附录部分，根据需要添加、删除内容，如代码
- `refs.bib` - 参考文献 `bib` 文件（**有则在此修改**）

---

## 使用

### 在线 LaTeX 编辑器

若在 [Overleaf](https://www.overleaf.com/)、[SJTU LaTeX 文档助手, 在线LaTeX编辑器](https://latex.sjtu.edu.cn) 等在线 LaTeX 编辑器上使用，可下载最新 [Releases](https://gitee.com/yangsl306/report-template-MMMS/releases)，上传至相应平台。

**注：Overleaf 等 在线 LaTeX 平台上默认使用 pdflatex 编译，需设置使用 XeLaTeX 编译。**

---

### 本地

>只在 Linux、macOS 测试过，Windows 端请自行测试（应该不难）

```bash
git clone https://gitee.com/yangsl306/report-template-MMMS.git
cd report-template-MMMS

# Makefile 编译
make               # make auto；生成 pdf 并删除中间文件
make help          # 打印帮助信息
make all           # 生成 pdf
make clean         # 删除中间文件
make cleanall      # 删除中间文件、pdf

# 手动编译
# 方式 1
latexmk -xelatex -time -halt-on-error main.tex

# 方式 2
./run.sh
```

---

## 文档内容

完整文档内容见 [mmms_report.pdf](./mmms_report.pdf)。

![文档封面](./assets/pdf1.png)
![文档目录](./assets/pdf2.png)
![文档正文](./assets/pdf3.png)

---

## To Do

见 [todo.md](./todo.md)。

---

## Changelog

见 [changelog.md](./changelog.md)。