Skip to content

Commit

Permalink
Update local installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
giovannipizzi authored Jul 14, 2022
1 parent 378d133 commit c6d490b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,23 @@ in the classroom. Students can also use them for self-learning.

## Local installation

One can git clone this repository and install all the required packages locally.
One can clone this repository and install all the required packages locally.
To do so (ideally in a fresh python virtual environment, to reduce risks of version clashes of some of the dependencies), run the following commands:

```bash
git clone https://github.com/osscar-org/quantum-mechanics.git
cd quantum-mechanics
pip install -e requirement.txt
pip install -r requirements.txt
```

To view the notebooks in the form of web application, one can type
Then, to view the notebooks in the form of a web application, you can type
the following command in the terminal:

```bash
voila --template=osscar --VoilaConfiguration.enable_nbextensions=True notebook/
```

Then, the web apps will be opened in the browser.
This will start the voila server and then open your default browser, where you can use the web application.

## Content

Expand Down

0 comments on commit c6d490b

Please sign in to comment.