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

use aiida-hq command #37

Merged
merged 3 commits into from
Sep 11, 2024
Merged

use aiida-hq command #37

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b700586
use `aiida-hp` command
superstar54 Sep 2, 2024
2e31ce3
Update docs/source/get_started.md
superstar54 Sep 11, 2024
61141db
Merge branch 'main' into fix/36/update_docs
superstar54 Sep 11, 2024
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
39 changes: 17 additions & 22 deletions docs/source/get_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,30 +79,25 @@ To start the server, simply run:

:::{code-block} console

verdi data hyperqueue server start eiger-hq
aiida-hq server start eiger-hq

:::

You can get more information on the server using:

:::{code-block} console

$ verdi data hyperqueue server info eiger-hq
+------------------+--------------------------+
| Server directory | /users/mbercx/.hq-server |
+------------------+--------------------------+
| Host | uan02 |
+------------------+--------------------------+
| Pid | 101525 |
+------------------+--------------------------+
| HQ port | 39211 |
+------------------+--------------------------+
| Workers port | 45549 |
+------------------+--------------------------+
| Start date | 2021-12-15 01:22:10 UTC |
+------------------+--------------------------+
| Version | 0.6.1 |
+------------------+--------------------------+
$ aiida-hq server info eiger-hq
+-------------+-------------------------+
| Server UID | 5yWtgC |
| Client host | eiger-ln002 |
| Client port | 32989 |
| Worker host | eiger-ln002 |
| Worker port | 43041 |
| Version | v0.18.0 |
| Pid | 181310 |
| Start date | 2024-09-02 17:51:12 UTC |
+-------------+-------------------------+

:::

Expand All @@ -118,18 +113,18 @@ For example:

:::{code-block} console

verdi data hyperqueue alloc add -Y eiger-hq -t 30m -- -A mr0 -C mc -p debug
aiida-hq alloc add -Y eiger-hq -t 30m -- -A mr0 -C mc -p debug

:::

Both the `-Y / --computer` option and `-t / --time-limit` options are required.
Use the `--hyper-threading` or `--no-hyper-threading` options to enable or disable hyper-threading for the worker allocation.
After the double hyphen `--`, you can place additional Slurm options to e.g. specify your project account (`-A`), constraints (`-C`) and the partition you want to run on (`-p`).
Once one or more allocations have been configured, you can check the list of allocations with `verdi data hyperqueue alloc list`:
Once one or more allocations have been configured, you can check the list of allocations with `aiida-hq alloc list`:

:::{code-block} console

$ verdi data hyperqueue alloc list eiger-hq
$ aiida-hq alloc list eiger-hq
+----+--------------+-------------------+-----------+---------+-------+-----------------------+
| ID | Backlog size | Workers per alloc | Timelimit | Manager | Name | Args |
+----+--------------+-------------------+-----------+---------+-------+-----------------------+
Expand All @@ -138,11 +133,11 @@ $ verdi data hyperqueue alloc list eiger-hq

:::

Finally, allocations can be removed with verdi data hyperqueue alloc remove:
Finally, allocations can be removed with aiida-hq alloc remove:
superstar54 marked this conversation as resolved.
Show resolved Hide resolved

:::{code-block} console

verdi data hyperqueue alloc remove -Y eiger-hq 1
aiida-hq alloc remove -Y eiger-hq 1

:::

Expand Down
Loading