From c6d490be0f0ae7babc2f03b296dfbe9879f06683 Mon Sep 17 00:00:00 2001 From: Giovanni Pizzi Date: Thu, 14 Jul 2022 05:51:10 +0200 Subject: [PATCH] Update local installation instructions --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 95bc202..dc0ac31 100644 --- a/README.md +++ b/README.md @@ -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