Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Extend Readme on how-to run tutorial locally #65

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

Merged
merged 4 commits into from
Apr 25, 2023
Merged

Extend Readme on how-to run tutorial locally #65

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebf77a4
Extend how-to run tutorial locally
edoardob90 Apr 19, 2023
0aeb623
Update README.md
edoardob90 Apr 19, 2023
85583cc
Update README.md
edoardob90 Apr 25, 2023
c58e3bf
Update README (2)
edoardob90 Apr 25, 2023
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
48 changes: 42 additions & 6 deletions 48 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,59 @@

## Run the tutorial on your computer

To run the tutorial locally, setup the environment with [conda](https://docs.conda.io/en/latest/miniconda.html) (or [mamba](https://mamba.readthedocs.io/en/latest/installation.html)):
### 0. Prerequisites

To run the tutorial locally, you should first install [conda](https://docs.conda.io/en/latest/miniconda.html) (or [mamba](https://mamba.readthedocs.io/en/latest/installation.html)).

It is also suggested that you have a recent version of `git`. Check out [how to install `git`](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) on your operating system.

### 1. Download the material

Go to the directory on your machine where you want to download the material and clone the repository:

```console
git clone https://github.com/empa-scientific-it/python-tutorial
```

Alternatively, you can manually download a ZIP archive with the latest version of the material:

[Download ZIP archive](https://github.com/empa-scientific-it/python-tutorial/archive/refs/heads/main.zip)

Extract the archive in a directory of your choice.

### 2. Create a dedicated environment

edoardob90 marked this conversation as resolved.
Show resolved Hide resolved
Enter the tutorial folder with

```console
conda env create -f environment.yml
cd /path/to/python-tutorial

```

You should now create a new environment with `conda`:

```console
conda env create -f binder/environment.yml
```

> **Warning**
>
> If you are on Windows and using Command Prompt or the PowerShell, please make sure to adjust the paths in the commands above accordingly.

Then activate the environment with
```console
conda activate python-tutorial
```

Finally, launch JupyterLab with
You can update the existing environment (that is, downloading the latest version of the packages) with

```console
jupyter lab
conda env update -f binder/environment.yml
```

To update the existing environment, run
### 3. Launch the tutorial via Jupyter

Finally, launch JupyterLab with
```console
conda env update -f environment.yml
jupyter lab
```
Morty Proxy This is a proxified and sanitized view of the page, visit original site.