You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mpcontribs-lux/README.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
<spanstyle="color:goldenrod"><i><b>Ego sum lux datorum</b></i></span>.
4
4
5
-
MPContribs-lux is a package which <it>sheds light</it> on data stored on the [Materials Project's AWS S3 OpenData bucket](https://materialsproject-contribs.s3.amazonaws.com/index.html#) by providing annotated schemas and optionally analysis tools to better explore user-submitted data.
5
+
MPContribs-lux is a package which <it>sheds light</it> on data stored on the [Materials Project's AWS S3 MPContribs bucket](https://materialsproject-contribs.s3.amazonaws.com/index.html#) by providing annotated schemas and optionally analysis tools to better explore user-submitted data.
6
6
7
-
Adding a schema to this database is a <spanstyle="color:red"><b>pre-requisite</b></span> for obtaining permission/IAM credentials for uploading data to MP's OpenData Bucket.
7
+
Adding a schema to this database is a <spanstyle="color:red"><b>pre-requisite</b></span> for obtaining permission/IAM credentials for uploading data to MP's MPContribs Bucket.
8
8
Once a staff member from MP reviews and approves your data schema, your receive IAM role will be granted/updated (as appropriate).
9
9
10
10
<spanstyle="color:red"><b>What if I don't want my schemas / data made public yet?</b></span>
@@ -26,4 +26,14 @@ When you're ready to make your data public, you will also have to make a public
26
26
<spanstyle="color:red"><b>But my CSV/JSON/YAML/etc. file isn't complicated. Why do I need to upload a schema?</b></span>
27
27
28
28
Schemas are important for ensuring accessibility, interoperability, and reproducibility, and for ensuring that you are fully aware of possible errors in your dataset.
29
-
If you are not comfortable mimicking the example `pydantic` schemas in `mpcontribs.lux.projects.examples`
29
+
If you are not comfortable mimicking the example `pydantic` schemas in `mpcontribs.lux.projects.examples`, you can either use the schema autogeneration features in `mpcontribs.lux.autogen`:
30
+
31
+
```py
32
+
from mpcontribs.lux.autogen import SchemaGenerator
0 commit comments