Skip to content

Commit

Permalink
✨readme updated with example #1
Browse files Browse the repository at this point in the history
  • Loading branch information
AvratanuBiswas committed May 23, 2022
1 parent 0e60c22 commit fb82a48
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@ Speck figures to Streamlit Web App

![Speclit demo](https://github.com/avrabyt/Specklit/blob/main/SpeckLit_demo.gif)

## Installation
`pip install st-speckmol==0.0.3`

## Example

```
import streamlit as st
import glob
from st_speckmol import spec_plot
# Example files path
ex_files = glob.glob("examples/*.xyz")
with st.sidebar:
example_xyz = st.selectbox("Select a molecule",ex_files)
f = open(example_xyz,"r")
example_xyz = f.read()
res = spec_plot(example_xyz)
```


# References

[Speck Online](http://wwwtyro.github.io/speck/)
Expand Down

0 comments on commit fb82a48

Please sign in to comment.