Skip to content

Commit ee19e89

Browse files
review comments
1 parent fc9bae8 commit ee19e89

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

mpcontribs-lux/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
<span style="color:goldenrod"><i><b>Ego sum lux datorum</b></i></span>.
44

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.
66

7-
Adding a schema to this database is a <span style="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 <span style="color:red"><b>pre-requisite</b></span> for obtaining permission/IAM credentials for uploading data to MP's MPContribs Bucket.
88
Once a staff member from MP reviews and approves your data schema, your receive IAM role will be granted/updated (as appropriate).
99

1010
<span style="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
2626
<span style="color:red"><b>But my CSV/JSON/YAML/etc. file isn't complicated. Why do I need to upload a schema?</b></span>
2727

2828
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
33+
34+
schema_gen = SchemaGenerator(file_name = "/path/to/some/csv/or/json/file")
35+
pydantic_model = schema_gen.pydantic_schema
36+
print(pydantic_model.model_fields)
37+
```
38+
39+
...or reach out to the maintainers!

mpcontribs-lux/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ description = "LUX: shed light on data published on MPContribs"
2222
readme = "README.md"
2323
requires-python = ">=3.11"
2424
dependencies = [
25-
"emmet-core>0.85.0",
25+
"emmet-core>0.86.0",
2626
"pyarrow",
2727
"pandas",
2828
]

0 commit comments

Comments
 (0)