Skip to content

Commit

Permalink
Add additional development instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewcarbone committed Jul 1, 2023
1 parent 4887bdc commit 04d5c63
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,28 @@ To install Lightshow, simply use `pip`
pip install lightshow
```

Make sure you've set your Pymatgen legacy API key as well!

```bash
export PMG_API_KEY="your_legacy_materials_project_key"
```

(or preferably, add `PMG_API_KEY` to your bash profile).

More details can be found at our [documentation](https://ai-multimodal.github.io/Lightshow/installation.html).

## Development installation

For developers: after cloning Lightshow locally, install `pre-commit` via

```bash
pip install pre-commit
pre-commit
pre-commit install
```

and check that the tests (below) work correctly.

## Running tests

For developers: tests can be run via `pytest`. After cloning, simply use
Expand All @@ -67,6 +87,12 @@ For developers: tests can be run via `pytest`. After cloning, simply use
pytest lightshow/_tests
```

or with coverage

```bash
pytest -v --cov --cov-report xml lightshow/_tests
```


# Contributing

Expand Down

0 comments on commit 04d5c63

Please sign in to comment.