Skip to content

Commit d78a5df

Browse files
committed
Update to mention dash-mp-components specifically
1 parent 90d34f2 commit d78a5df

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

docs_rst/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:hidden:
33

44
introduction
5-
Try The App!<https://materialsproject.org/#apps/xtaltoolkit>
5+
Try The App!<https://next-gen.materialsproject.org/toolkit>
66
first_web_app
77
first_component
88
components

docs_rst/introduction.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ transform crystal structures and molecules.
2222
Crystal Toolkit Demonstration App
2323
---------------------------------
2424

25-
You can visit the current Crystal Toolkit web app `here. <https://materialsproject.org/#apps/xtaltoolkit>`_
25+
You can visit the current Crystal Toolkit web app `here. <https://next-gen.materialsproject.org/toolkit>`_
2626

2727

2828
Crystal Toolkit Web Framework
@@ -32,7 +32,12 @@ Crystal Toolkit is designed as a modular, object-orientated suite of UI componen
3232
built upon the `Dash framework by Plotly <https://dash.plot.ly>`_. The main Crystal Toolkit web app is just
3333
one example of using these components.
3434

35-
...
35+
The custom Dash components developed for use by Crystal Toolkit are available at
36+
`dash-mp-components <https://github.com/materialsproject/dash-mp-components>`_, and
37+
powered by our custom React components available at
38+
`mp-react-components <https://github.com/materialsproject/mp-react-components>`_. These
39+
can be explored interactively in our
40+
`Storybook <https://materialsproject.github.io/mp-react-components/?path=/story/introduction-mp-react-components--page>`_.
3641

3742
Installation
3843
------------
@@ -59,6 +64,15 @@ Make sure to set your ``PMG_MAPI_KEY`` appropriately.
5964
If you need a Materials Project API key, please get a free account on
6065
`Materials Project <https://materialsproject.org>`_ and access your dashboard.
6166

67+
68+
Dash 2.x Migration
69+
------------------
70+
71+
Crystal Toolkit works with both Dash 1.x and Dash 2.x. Several design choices were made
72+
before Dash 2.x was developed that may be re-evaluated in future as new functionality
73+
becomes available.
74+
75+
6276
Development Team
6377
----------------
6478

@@ -68,7 +82,8 @@ The `Crystal Toolkit Development Team <https://github.com/materialsproject/cryst
6882

6983
Contributors
7084

71-
* `François Chabbey <https://github.com/chabb>`_ for React components
85+
* `Cody O'Donnell <https://github.com/codytodonnell>`_ primary developer of custom React components
86+
* `François Chabbey <https://github.com/chabb>`_ for development of React components
7287
* `Jimmy Shen <https://github.com/jmmshn>`_ contributed pythreejs support, surface plotting, initial arrows/axes support, and various bug fixes
7388
* `Joey Montoya <https://github.com/JosephMontoya-TRI>`_ contributed Pourbaix component
7489
* `Shyam Dwaraknath <https://github.com/shyamd>`_ for planned contributions for ellipsoid support and architectural design

0 commit comments

Comments
 (0)