Skip to content

Commit aab48eb

Browse files
committed
Add readme table with binder and GH links to example apps (see #282)
1 parent c239fc6 commit aab48eb

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,28 @@ Following a discussion with a potential contributor, "new contributor" issues ar
1919

2020
[Documentation can be found at docs.crystaltoolkit.org](https://docs.crystaltoolkit.org)
2121

22+
## Example Apps
23+
24+
| Description | Link    |
25+
| :--------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| **`bandstructure.py`**<br> Demonstrates capabilities of the `BandstructureAndDosComponent` component | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/bandstructure.py) |
27+
| **`basic_hello_structure.py`**<br> Uses `StructureMoleculeComponent` to show a simple `pymatgen` structure | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/basic_hello_structure.py) |
28+
| **`basic_hello_structure_interactive.py`**<br> Adds a button to the `basic_hello_structure.py` to toggle between two structures interactively | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/basic_hello_structure_interactive.py) |
29+
| **`basic_hello_world.py`**<br> Bare-bones example showing how to render the text "Hello scientist!" in Dash app | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/basic_hello_world.py) |
30+
| **`diffraction.py`**<br> Demonstrates capabilities of the `XRayDiffractionComponent` component | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/diffraction.py) |
31+
| **`diffraction_dynamic.py`**<br> Adds a button to `diffraction.py` to load a new structure on the fly | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/diffraction_dynamic.py) |
32+
| **`diffraction_empty.py`**<br> Shows `XRayDiffractionComponent` can be mounted without a passing structure | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/diffraction_empty.py) |
33+
| **`kwarg_inputs.py`**<br> Shows off boolean input (aka toggle), matrix input and slider input components | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/kwarg_inputs.py) |
34+
| **`phase_diagram.py`**<br> Combines `MPRester.get_entries_in_chemsys()` and the `PhaseDiagram` component to plot the Li-O-Co convex hull | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/phase_diagram.py) |
35+
| **`pourbaix.py`**<br> Combines `MPRester.get_pourbaix_entries()` and the `PourbaixDiagramComponent` to plot the Fe-CO Pourbaix diagram | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/pourbaix.py) |
36+
| **`structure.py`**<br> Show cases multiple layout options for the `StructureMoleculeComponent` | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/structure.py) |
37+
| **`structure_magnetic.py`**<br> Plots a structure with magnetic moments | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/structure_magnetic.py) |
38+
| **`transformations.py`**<br> Combines `StructureMoleculeComponent` and `AllTransformationsComponent` to apply interactive structure transformations | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/transformations.py) |
39+
| **`transformations_minimal.py`**<br> Shows how to restrict the types of allowed transformations | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/transformations_minimal.py) |
40+
| **`write_structure_screenshot_to_file.py`**<br> Shows to save interactive structure views as image files | [![View on GitHub]](https://github.com/materialsproject/crystaltoolkit/blob/main/crystal_toolkit/apps/examples/write_structure_screenshot_to_file.py) |
41+
42+
[View on GitHub]: https://img.shields.io/badge/View-GitHub-darkblue?logo=github
43+
2244
## Team and Contribution Policy
2345

2446
The [Crystal Toolkit Development Team](https://github.com/materialsproject/crystaltoolkit/graphs/contributors) includes:

0 commit comments

Comments
 (0)