Skip to content

Commit 08f2d2c

Browse files
authored
Update "Future of This Repository" section
1 parent c69287a commit 08f2d2c

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,11 @@ New contributors are welcome, please see our [Code of Conduct.](code-of-conduct.
3939

4040
## Future of This Repository
4141

42-
The Crystal Toolkit repo currently contains three major parts:
42+
The Crystal Toolkit repository is home of an object-orientated Python framework for rendering materials science data based on the schema employed by the Materials Project.
4343

44-
* An object-orientated Python framework for rendering materials science data based on the schema employed by the Materials Project
45-
* A few custom Plotly Dash components (Simple3DSceneComponent, JSONComponent, GraphComponent)
46-
* Some example apps using these components
44+
The custom Plotly Dash components that power Crystal Toolkit are now maintained in a [separate repository](https://github.com/materialsproject/dash-mp-components) for ease of development, as well as the [custom React components](https://github.com/materialsproject/mp-react-components). These components were formerly included in the Crystal Toolkit repo, and are still considered part of Crystal Toolkit in spirit.
4745

48-
It is likely the custom Plotly Dash components might be spun off into a separate repo at some point to reduce the complexity of the Crystal Toolkit repo itself.
46+
There are some [important issues](https://github.com/materialsproject/crystaltoolkit/issues/265) still to be resolved, as well as general improvements to documentation and test suite planned. Some [currently-private code](https://github.com/materialsproject/crystaltoolkit/issues/264) is also planned to be re-incorporated into the public Crystal Toolkit repo.
4947

5048
## Acknowledgements
5149

0 commit comments

Comments
 (0)