Crystal Toolkit is a web app framework from the Materials Project allowing Python
Project description
Crystal Toolkit
Call for new contributors
Crystal Toolkit is an academic project. A manuscript is in preparation to detail the design goals of Crystal Toolkit and achievements to date.
If you are interested in getting involved in Crystal Toolkit and are not already, it is not too late to be included in this manuscript, but please get in touch with mkhorton@lbl.gov ASAP. Include information on the specific contributions that you would like to make (e.g. this may include adding features, addressing bugs, writing documentation, manuscript preparation, community engagement, writing tests, and the like), and if these align with the project we can formally add you to the development team.
Following a discussion with a potential contributor, "new contributor" issues are assigned. A current list of new contributor issues can be seen here.
Status
Documentation
Documentation can be found at docs.crystaltoolkit.org
Example Apps
| Description | Link |
|---|---|
bandstructure.pyDemonstrates capabilities of the BandstructureAndDosComponent component |
 |
basic_hello_structure.pyUses StructureMoleculeComponent to show a simple pymatgen structure |
|
basic_hello_structure_interactive.pyAdds a button to the basic_hello_structure.py to toggle between two structures interactively |
|
basic_hello_world.pyBare-bones example showing how to render the text "Hello scientist!" in Dash app |
|
diffraction.pyDemonstrates capabilities of the XRayDiffractionComponent component |
|
diffraction_dynamic.pyAdds a button to diffraction.py to load a new structure on the fly |
|
diffraction_empty.pyShows XRayDiffractionComponent can be mounted without a passing structure |
|
kwarg_inputs.pyShows off boolean input (aka toggle), matrix input and slider input components |
|
phase_diagram.pyCombines MPRester.get_entries_in_chemsys() and the PhaseDiagram component to plot the Li-O-Co convex hull |
|
pourbaix.pyCombines MPRester.get_pourbaix_entries() and the PourbaixDiagramComponent to plot the Fe-CO Pourbaix diagram |
|
structure.pyShow cases multiple layout options for the StructureMoleculeComponent |
|
structure_magnetic.pyPlots a structure with magnetic moments |
|
transformations.pyCombines StructureMoleculeComponent and AllTransformationsComponent to apply interactive structure transformations |
|
transformations_minimal.pyShows how to restrict the types of allowed transformations |
|
write_structure_screenshot_to_file.pyShows to save interactive structure views as image files |
|
Team and Contribution Policy
The Crystal Toolkit Development Team includes:
- Matthew Horton, lead
- François Chabbey for React components
- Jimmy Shen contributed pythreejs support, surface plotting, initial arrows/axes support, and various bug fixes
- Joey Montoya contributed Pourbaix component
- Shyam Dwaraknath for planned contributions for ellipsoid support and architectural design
- Donny Winston, assisted by Tyler Huntington, for helping embed Crystal Toolkit in a Django app
- Matt McDermott contributed phase diagram, X-ray Diffraction, X-ray Absorption Spectrum components
- Jason Munro contributed band structure component
- Stephen Weitzner contributed POV-Ray integration (in progress)
- Richard Tran for contributing plotly-powered Wulff shapes to pymatgen, which Crystal Toolkit uses
- Guy Moore for contributing magnetic moment visualization
New contributors are welcome, please see our Code of Conduct. If you are a new contributor please modify this README in your Pull Request to add your name to the list.
Future of This Repository
The Crystal Toolkit repository is home of an object-oriented Python framework for rendering materials science data based on the schema employed by the Materials Project.
The custom Plotly Dash components that power Crystal Toolkit are now maintained in a separate repository for ease of development, as well as the custom React components. These components were formerly included in the Crystal Toolkit repo, and are still considered part of Crystal Toolkit in spirit.
There are some important issues still to be resolved, as well as general improvements to documentation and test suite planned. Some currently-private code is also planned to be re-incorporated into the public Crystal Toolkit repo.
Acknowledgements
Thank you to all the authors and maintainers of the libraries Crystal Toolkit depends upon, and in particular pymatgen for crystallographic analysis and Dash from Plotly for their web app framework.
Thank you to the NERSC Spin service for hosting the app and for their technical support.
Cross-browser Testing Platform and Open Source <3 generously provided by Sauce Labs
Contact
Please contact @mkhorton with any queries or add an issue on the GitHub Issues page.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for crystal_toolkit-2022.11.17.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ec74317a3cdb34857e640f7515721e66721092988d501f64d6ea4e5843c666df |
|
| MD5 | 088c10c8a5bf11e509f0a47c9a01120c |
|
| BLAKE2b-256 | 7ee1125a333262615d9236eb12f265f69017f70f35462c3d0e5d7dae5df3788e |
Hashes for crystal_toolkit-2022.11.17-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5bfda14d7356fb97b846cb545bd590fb138c821c07f8ea2aacc1b3d69e61e52c |
|
| MD5 | 8585b9c056229038fa5999ffdabcffe6 |
|
| BLAKE2b-256 | 5dcc6cddf5e1b3cad437d7b6408b79f964bfd2725bab157a3dbc5b2a0d443a0b |
