Skip to content

Commit

Permalink
Add instruction for aiidalab-launch (#446)
Browse files Browse the repository at this point in the history
Add instruction for aiidalab-launch to set page for setting env on local computer.
  • Loading branch information
unkcpz committed Oct 4, 2022
1 parent 2cd53f8 commit 5f9f07e
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/sections/getting_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,36 @@ To run the tutorial on your own machine, you need to install:

```{note} Version numbers indicate the versions with which the tutorial was tested.
```

### using AiiDAlab Launch

AiiDAlab Launch makes it easy to run AiiDAlab on your own workstation or laptop.

To use AiiDAlab launch you will have to

1. [Install Docker on your workstation or laptop](https://docs.docker.com/get-docker/) and [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/).
2. Install AiiDAlab launch with [pipx](https://pypa.github.io/pipx/installation/) (**recommended**):

```console
pipx install aiidalab-launch
```

_Or directly with pip (`pip install aiidalab-launch`)._

3. Create a profile for tutorial

```console
aiidalab-launch profiles add tutorial
```

It will ask you to edit the profile, since for the tutorial we only need the AiiDA environment, answer `Y` and let's remove the `aiidalab-widgets-base` from the `default_apps` list (or the whole `default_apps` line).


3. Start AiiDAlab for `tutorial` profile with

```console
aiidalab-launch start -p tutorial
```
4. Follow the instructions on screen to open AiiDAlab in the browser.

See `aiidalab-launch --help` for detailed help.

0 comments on commit 5f9f07e

Please sign in to comment.