Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #8

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Update README.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ The library is built off of [`stk`](https://stk.readthedocs.io/en/stable/), whic

# Installation

`bbprepared` is a `pip` installable library, or can be installed with the following instructions.
`bbprepared` is a `pip` installable library:
```
$ pip install bbprepared
```

The code can be installed following these steps:
The code can be also installed following these steps:

1. clone `bbprepared` from [here](https://github.com/andrewtarzia/bbprepared)

Expand Down Expand Up @@ -37,4 +40,4 @@ $ pip install -e .

# Acknowledgements

This work is a mixture of codes developed throughout my postdoc in the [Jelfs Group](http://www.jelfs-group.org/), and the [Pavan Group](https://www.gmpavanlab.com/), and during my time as a developer of [`stk`](https://stk.readthedocs.io/en/stable/) and [`stko`](https://github.com/JelfsMaterialsGroup/stko) with Lukas Turcani.
This work is a mixture of codes developed throughout my postdoc in the [Jelfs Group](http://www.jelfs-group.org/), and the [Pavan Group](https://www.gmpavanlab.com/), and during my time as a developer of [`stk`](https://stk.readthedocs.io/en/stable/) and [`stko`](https://github.com/JelfsMaterialsGroup/stko) with Lukas Turcani.