Skip to content

Commit a847c5c

Browse files
committed
update lux example readme
1 parent 7ef4fbe commit a847c5c

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

mpcontribs-lux/examples/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ If you are less comfortable with python, or have non-columnar data, then you sho
1717

1818
You will need an account with the Materials Project.
1919
Once you've signed in, copy your API key from your [dashboard](https://next-gen.materialsproject.org/api) and either
20+
2021
1. Run from a terminal:
21-
```
22-
echo 'export MP_API_KEY=<your api key>' >> ~/.bashrc
23-
echo 'export MPCONTRIBS_API_KEY=$MP_API_KEY' >> ~/.bashrc
22+
```
23+
echo 'export MP_API_KEY=<your api key>' >> ~/.bashrc
24+
echo 'export MPCONTRIBS_API_KEY=$MP_API_KEY' >> ~/.bashrc
25+
```
26+
2427
```
2528
and replace `<your api key>`, and ~/.bashrc with ~/.zshrc, etc. as appropriate.
2629
2730
2. Use it explicitly in the API client code
2831
3. Use an alternate environment variable solution like `.env` files.
2932
3033
For a python environment, you will need the packages in `requirements.txt`.
31-
If you need to upload <b>large (>15 MB/document limit of MongoDB) or raw data</b>, this guide will instruct you how to upload those data objects to the Materials Project's AWS OpenData bucket, <b><i>pending permission/IAM credentials from Materials Project staff</i></b>.
3234
If you are uploading large data, we strongly recomment using the `pyarrow` package to write parquet files for data that is amenable to more columnar formats, and `zarr` for hierarchical/HDF5-like/netCDF-like or tensorial data.
35+
```

0 commit comments

Comments
 (0)