New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API documentation needs #1

Open

volkerblum opened this issue Jun 22, 2021 · 1 comment

Contributor

volkerblum commented Jun 22, 2021

In the HybriD3 documentation, we should document the API in three separate points:

Point out that HybriD3 is historically optimized for in-browser usage and therefore no completely high-powered API but please work with us for specific needs
Working hands-on examples for different uses of the API -> Xiaochen example of two properties in same query, what else?
Point to MatD3 software documentation for origin of API and more systematic documentation in terms of writeup and code.

Contributor Author

volkerblum commented Jun 22, 2021

Example query from Xiaochen:

https://materials.hybrid3.duke.edu/materials/datasets/summary/?primary_property__name=photoluminescence&secondary_property__name=energy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment