高通量二维材料模块
twod_materials的Python项目详细描述
[![构建状态](https://travis-ci.org/ashtonmv/twod_materials.svg?branch=master)(https://travis ci.org/ashtonmv/twod_materials)
[![覆盖](https://codecov.io/gh/ashtonmv/twod_materials/coverage.svg?branch=master);(https://codecov.io/gh/ashtonmv/twod廑u materials)
<;img src=“https://s3.amazonaws.com/mashton/twod廑u materials廑logo.png”alt=“drawing”width=“200”/>;
关于twod廑u materials的官方文档,其中包括一整套教程,可以在
[这里](https://pythonhosted.org/twod-materials/)。
关于“twod-materials”的非正式但维护良好的文档,
包括教程。
在我关于发现和表征二维材料的研究中。其中有些我用了几千次,而另一些我用了不到五次。在
“两种材料”中的功能是以用户友好性为优先考虑的,
有时是以灵活性为代价的。例如,一些
后处理函数将假定您在组织计算时使用了特定的目录
结构。这里的目标不是限制性的,而是简化的。
正在克隆此存储库。在系统上克隆后,运行“pip install numpy”,然后运行
“pip install-r requirements.txt”安装其依赖项。然后应该将其位置添加到系统的`$pythonpath`中,这样就可以从任何地方导入其
函数。有几种方法可以做到这一点,包括在`~/.bashrc`文件中添加
以下行:
````
export pythonpath=$pythonpath:/path/to/twod嫒u materials`显然可以使用系统设置更改此
```
edit config.yaml,以下模板:
````
mp-api:you_-materials_-materials_-project_-api-key
normal_-normal_-vasp_可执行文件路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径/>如何包装“双材料”中有五个成熟的模块:“稳定性”、“电子结构”、“pourbaix”、“摩擦”和“插层”。
“磁性”模块目前还处于初级阶段。“utils”模块
基本上只是在其他
包中使用的助手函数库。
这些模块中的每个都有两个子模块:“startup”和“analysis”。对于
大多数模块,“startup”包含通过与计算机的队列系统(pbs或slurm)交互来设置和提交vasp
计算的函数。将“startup”子模块看作预处理工具可能会有帮助。
“analysis”子模块包含后处理功能。这些后处理功能可以分为两大类:用于分析数据的功能和用于绘制数据的功能。所有绘图函数都使用
`matplotlib`.
其中:
potcar_symbols.yaml和“pourbaix”模块下的yaml文件。
[![覆盖](https://codecov.io/gh/ashtonmv/twod_materials/coverage.svg?branch=master);(https://codecov.io/gh/ashtonmv/twod廑u materials)
<;img src=“https://s3.amazonaws.com/mashton/twod廑u materials廑logo.png”alt=“drawing”width=“200”/>;
关于twod廑u materials的官方文档,其中包括一整套教程,可以在
[这里](https://pythonhosted.org/twod-materials/)。
包括教程。
在我关于发现和表征二维材料的研究中。其中有些我用了几千次,而另一些我用了不到五次。在
“两种材料”中的功能是以用户友好性为优先考虑的,
有时是以灵活性为代价的。例如,一些
后处理函数将假定您在组织计算时使用了特定的目录
结构。这里的目标不是限制性的,而是简化的。
正在克隆此存储库。在系统上克隆后,运行“pip install numpy”,然后运行
“pip install-r requirements.txt”安装其依赖项。然后应该将其位置添加到系统的`$pythonpath`中,这样就可以从任何地方导入其
函数。有几种方法可以做到这一点,包括在`~/.bashrc`文件中添加
以下行:
````
export pythonpath=$pythonpath:/path/to/twod嫒u materials`显然可以使用系统设置更改此
```
edit config.yaml,以下模板:
````
mp-api:you_-materials_-materials_-project_-api-key
normal_-normal_-vasp_可执行文件路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径路径/>如何包装“双材料”中有五个成熟的模块:“稳定性”、“电子结构”、“pourbaix”、“摩擦”和“插层”。
“磁性”模块目前还处于初级阶段。“utils”模块
基本上只是在其他
包中使用的助手函数库。
这些模块中的每个都有两个子模块:“startup”和“analysis”。对于
大多数模块,“startup”包含通过与计算机的队列系统(pbs或slurm)交互来设置和提交vasp
计算的函数。将“startup”子模块看作预处理工具可能会有帮助。
“analysis”子模块包含后处理功能。这些后处理功能可以分为两大类:用于分析数据的功能和用于绘制数据的功能。所有绘图函数都使用
`matplotlib`.
其中:
potcar_symbols.yaml和“pourbaix”模块下的yaml文件。