欢迎来到PhyStar使用手册
- 由于语雀平台停止对教育用户免费,故将代码使用手册再次移到Github,并用mkdocs进行文档管理。
- 自2026年起,PhyStar开始维护代号 Lushan 版本 (v0.2.x),其余版本停止维护
- 如果需要查看其他版本的手册,可以访问 https://phystar-group.github.io/ 导航。
- 程序的API手册见 https://phystar-group.github.io/APIDocument/
- 为了保证质量和效率,开发前,请务必仔细阅读 :doc:
开发规范 <Specification/index_spec>
- 因为时间紧迫,文档可能存在诸多表述不清或者错误的表述。希望读者发现后向我们及时反馈。反馈途径如下:
- 联系邮箱: czw17@tsinghua.org.cn / cuizhiwen@hnu.edu.cn
引导
- 快速开始:快速运行程序,实现第一个例子。
- 新手指南:针对不了解或不熟悉Linux系统以及开发环境的使用者,给出一些使用建议
- 使用手册:程序具体的使用手册与指南,比如ControlDict.toml文件的字典含义,参数设置等
- 程序手册:程序各个部分的内容,比如程序结构,并行原理等
- 算例手册:针对典型算例,进行介绍,比如参数、模型与运行
- API文档:程序中各个函数与类的调用接口
- 其它资料:其它有助于使用程序的资料,比如toml语法,C++语法等