Crystal Toolkit是Materials Project的一个Web应用程序框架，允许Python
项目描述
Crystal Toolkit
引用
您可以在我们的预印本中了解更多关于Crystal Toolkit的信息，可在此找到。
有一个引用.cff文件可用，或BibTeX引用如下
@article{horton2023crystal,
title={Crystal Toolkit: A Web App Framework to Improve Usability and Accessibility of Materials Science Research Algorithms},
author={Horton, Matthew and Shen, Jimmy-Xuan and Burns, Jordan and Cohen, Orion and Chabbey, Fran{\c{c}}ois and Ganose, Alex M and Guha, Rishabh and Huck, Patrick and Li, Hamming Howard and McDermott, Matthew and others},
journal={arXiv preprint arXiv:2302.06147},
year={2023}
}
如果您使用Crystal Toolkit，无论是用于自己的Web应用程序，还是在工作中包含由Crystal Toolkit生成的图像，请确保适当引用它！ 引用是认可Crystal Toolkit开发人员贡献的好方法，并允许我们了解它在社区中的使用情况。
感兴趣于贡献？
可以在此找到当前新贡献者问题的列表。如果您希望分配一个新贡献者问题，请与项目负责人联系！
状态
安装
pip install crystal-toolkit
文档
文档可在docs.crystaltoolkit.org找到。
示例应用程序
| 描述 | |
|---|---|
| bandstructure.py 演示了 BandstructureAndDosComponent组件的功能 |
 |
| basic_hello_structure.py 使用 StructureMoleculeComponent显示一个简单的pymatgen结构 |
|
| basic_hello_structure_interactive.py 向 basic_hello_structure.py添加按钮，以交互式地在两个结构之间切换 |
|
| basic_hello_world.py 裸机示例，展示如何在Dash应用程序中渲染文本“Hello scientist!” |
|
| diffraction.py 演示了 XRayDiffractionComponent组件的功能 |
|
| diffraction_dynamic.py 向 diffraction.py添加了一个按钮，用于动态加载新结构 |
|
| diffraction_empty.py 显示 XRayDiffractionComponent可以在没有传递结构的情况下进行挂载 |
|
| kwarg_inputs.py 展示了布尔输入（又称切换）、矩阵输入和滑动输入组件 |
|
| phase_diagram.py 将 MPRester.get_entries_in_chemsys()和PhaseDiagram组件结合起来，绘制Li-O-Co凸包 |
|
| pourbaix.py 将 MPRester.get_pourbaix_entries()和PourbaixDiagramComponent组件结合起来，绘制Fe-CO Pourbaix图 |
|
| structure.py 展示了 StructureMoleculeComponent的多种布局选项 |
|
| structure_magnetic.py 绘制具有磁矩的结构 |
|
| matbench_dielectric_structure_on_hover.py 创建一个与 StructureMoleculeComponent和DataTable相连的散点图，该图显示结构并突出显示与悬停散点点对应的表格行。 |
|
| matbench_dielectric_datatable_xrd.py 将 DataTable渲染到与StructureMoleculeComponent和XRayDiffractionComponent相连，以便悬停表格行时显示相应的结构和其XRD模式。 |
|
| transformations.py 将 StructureMoleculeComponent和AllTransformationsComponent结合起来，以应用交互式结构变换 |
|
| transformations_minimal.py 显示如何限制允许的变换类型 |
|
| write_structure_screenshot_to_file.py 显示如何将交互式结构视图保存为图像文件 |
|
团队和贡献政策
- Matthew Horton，负责人
- François Chabbey负责React组件
- Jimmy Shen贡献了pythreejs支持、表面绘图、初始箭头/坐标轴支持以及各种错误修复
- Joey Montoya贡献了Pourbaix组件
- Shyam Dwaraknath负责椭圆体支持和架构设计
- Donny Winston，由Tyler Huntington协助，帮助将Crystal Toolkit嵌入Django应用程序
- Matt McDermott贡献了相图、X射线衍射、X射线吸收光谱组件
- Jason Munro贡献了能带结构组件
- Janosh Riebesell贡献了声子能带结构组件、3个示例应用程序、测试
- Stephen Weitzner贡献了POV-Ray集成（正在进行中）
- Richard Tran为将基于plotly的Wulff形状贡献给pymatgen，Crystal Toolkit使用这些形状
- Guy Moore为贡献磁矩可视化
- Steve Zeltmann为贡献电子衍射
- Patrick Huck，MP / MPContribs的发布、运营、错误修复和POC
欢迎新贡献者，请参阅我们的行为准则。如果您是新的贡献者，请在您的Pull Request中修改此README文件，以将您的姓名添加到列表中。
此存储库的未来
Cystal Toolkit存储库是Materials Project采用的模式的对象式Python框架的家园，用于渲染材料科学数据。
为Crystal Toolkit提供动力的自定义Plotly Dash组件现在维护在一个单独的存储库中，以方便开发，以及自定义React组件。这些组件以前包含在Crystal Toolkit存储库中，并且在精神上仍然被认为是Crystal Toolkit的一部分。
还有一些重要问题尚未解决，包括对文档和测试套件的总体改进计划。一些目前为私有代码也计划重新整合到公共Crystal Toolkit库中。
致谢
感谢所有依赖的库的作者和维护者，特别是pymatgen用于晶体学分析，以及来自Plotly的Dash用于他们的Web应用框架。
感谢NERSC Spin服务提供应用托管和他们的技术支持。
联系方式
如有任何疑问，请联系@mkhorton，或在GitHub Issues页面上添加问题。
crystal_toolkit-2023.11.3.tar.gz的哈希
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | d17c15c3b6ab6d800da012db332b64abea1f826581eee47a89aedfebc723aa2c |
|
| MD5 | 309ec23e34ef4d4e61927291178d86b6 |
|
| BLAKE2b-256 | 7d62e319cbddaa367d86985454c85c3c0efed469f4536ae2ca16442e1c99cb5a |