HybriD3-database / HybriD3

0 stars 1 forks source link

API documentation needs #1

Open volkerblum opened 3 years ago

volkerblum commented 3 years ago

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

1) 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

2) Working hands-on examples for different uses of the API -> Xiaochen example of two properties in same query, what else?

3) Point to MatD3 software documentation for origin of API and more systematic documentation in terms of writeup and code.

volkerblum commented 3 years ago

Example query from Xiaochen:

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