Skip to content

Commit b25e5d6

Browse files
authored
update helmi modules -> fiqci modules (#2615)
1 parent a670929 commit b25e5d6

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

docs/apps/cirq-on-iqm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags:
66
# Cirq-on-iqm
77

88
Cirq on IQM is an open-source cirq adapter for IQM quantum computers. It is
9-
installed as `helmi_cirq` on LUMI. It is used for running quantum circuits on
9+
installed as `fiqci-vtt-cirq` on LUMI. It is used for running quantum circuits on
1010
[Helmi](../computing/quantum-computing/helmi/running-on-helmi.md).
1111

1212
## Available
@@ -15,7 +15,7 @@ Currently supported [cirq-on-iqm](https://iqm-finland.github.io/cirq-on-iqm/) ve
1515

1616
| Version | Module | LUMI | Notes |
1717
|:--------|:-------------------------------------|:-----:|-----------------|
18-
| 15.2 | `helmi_cirq/15.2` | X | |
18+
| 15.2 | `fiqci-vtt-cirq/15.2` | X | |
1919

2020

2121
All modules are based on Tykky using LUMI-container-wrapper.
@@ -33,7 +33,7 @@ cirq-on-iqm is licensed under
3333

3434
## Usage
3535

36-
To use `helmi_cirq` on LUMI, initialize it with:
36+
To use `fiqci-vtt-cirq` on LUMI, initialize it with:
3737

3838
```bash
3939
module use /appl/local/quantum/modulefiles
@@ -42,13 +42,13 @@ module use /appl/local/quantum/modulefiles
4242
and
4343

4444
```bash
45-
module load helmi_cirq
45+
module load fiqci-vtt-cirq
4646
```
4747

48-
This command will also show how to load `helmi_cirq`:
48+
This command will also show how to load `fiqci-vtt-cirq`:
4949

5050
```bash
51-
module avail helmi_cirq
51+
module avail fiqci-vtt-cirq
5252
```
5353

5454
### Example batch script
@@ -69,7 +69,7 @@ Example batch script for running a quantum job on Helmi:
6969
#SBATCH --account=project_xxx # Project for billing
7070

7171
module use /appl/local/quantum/modulefiles
72-
module load helmi_cirq
72+
module load fiqci-vtt-cirq
7373

7474
python -u quantum_job.py
7575
```

docs/apps/qiskit-on-iqm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags:
66
# Qiskit-on-iqm
77

88
Qiskit on IQM is an open-source qiskit adapter for IQM quantum computers. It is
9-
installed as `helmi_qiskit` on LUMI. It is used for running quantum circuits on
9+
installed as `fiqci-vtt-qiskit` on LUMI. It is used for running quantum circuits on
1010
[Helmi](../computing/quantum-computing/helmi/running-on-helmi.md).
1111

1212

@@ -17,7 +17,7 @@ versions:
1717

1818
| Version | Module | LUMI | Notes |
1919
|:--------|:-------------------------------------|:-----:|-----------------|
20-
| 15.5 | `helmi_qiskit/15.5` | X | |
20+
| 15.5 | `fiqci-vtt-qiskit/15.5` | X | |
2121

2222
All modules are based on Tykky using LUMI-container-wrapper.
2323
Wrapper scripts have been provided so that common commands such as `python`,
@@ -34,7 +34,7 @@ qiskit-on-iqm is licensed under
3434

3535
## Usage
3636

37-
To use `helmi_qiskit` on LUMI, initialize it with:
37+
To use `fiqci-vtt-qiskit` on LUMI, initialize it with:
3838

3939
```bash
4040
module use /appl/local/quantum/modulefiles
@@ -43,13 +43,13 @@ module use /appl/local/quantum/modulefiles
4343
and
4444

4545
```bash
46-
module load helmi_qiskit
46+
module load fiqci-vtt-qiskit
4747
```
4848

49-
This command will also show how to load `helmi_qiskit`:
49+
This command will also show how to load `fiqci-vtt-qiskit`:
5050

5151
```bash
52-
module avail helmi_qiskit
52+
module avail fiqci-vtt-qiskit
5353
```
5454

5555
### Example batch script
@@ -70,7 +70,7 @@ Example batch script for running a quantum job on Helmi:
7070
#SBATCH --account=project_xxx # Project for billing
7171

7272
module use /appl/local/quantum/modulefiles
73-
module load helmi_qiskit
73+
module load fiqci-vtt-qiskit
7474

7575
python -u quantum_job.py
7676
```

docs/computing/quantum-computing/helmi/first-quantum-job.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module load Local-quantum
2121
You can then see the list of available *modules* with `module avail`. The quantum modules should be at the top! In this walkthrough Qiskit will be used, therefore the next step is to load the module into our current environment with
2222

2323
```bash
24-
module load helmi_qiskit
24+
module load fiqci-vtt-qiskit
2525
```
2626

2727
## Creating your first quantum program
@@ -71,7 +71,7 @@ Now the circuit is created! If you wish you can see what your circuit looks like
7171

7272
## Setting the backend
7373

74-
First we need to set our provider and backend. The provider is the service which gives an interface to the quantum computer and the backend provides the tools necessary to submitting the quantum job. The `HELMI_CORTEX_URL` is the endpoint to reach Helmi and is only reachable inside the `q_fiqci` partition. This environment variable is set automatically when loading any of the `helmi_*` modules such as the `helmi_qiskit` module.
74+
First we need to set our provider and backend. The provider is the service which gives an interface to the quantum computer and the backend provides the tools necessary to submitting the quantum job. The `HELMI_CORTEX_URL` is the endpoint to reach Helmi and is only reachable inside the `q_fiqci` partition. This environment variable is set automatically when loading any of the Quantum computing modules such as the `fiqci-vtt-qiskit` module.
7575

7676
```python
7777
HELMI_CORTEX_URL = os.getenv('HELMI_CORTEX_URL')
@@ -176,7 +176,7 @@ This submits the job *interactively* meaning that the output will be printed str
176176
#SBATCH --account=project_xxx # Project for billing
177177

178178
module use /appl/local/quantum/modulefiles
179-
module load helmi_qiskit
179+
module load fiqci-vtt-qiskit
180180

181181
python -u first_quantum_job.py
182182
```

docs/computing/quantum-computing/helmi/running-on-helmi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ To submit and run jobs on Helmi you need to use the correct environment on LUMI.
1313

1414
* First, run `module use /appl/local/quantum/modulefiles`. The available modules will now show up on `module avail`.
1515
* Second, depending on if you want to use the Qiskit or Cirq environment, run:
16-
* `module load helmi_qiskit` or
17-
* `module load helmi_cirq`
16+
* `module load fiqci-vtt-qiskit` or
17+
* `module load fiqci-vtt-cirq`
1818

1919

20-
`helmi_qiskit` and `helmi_cirq` provide pre-made python environments to directly run on Helmi.
20+
`fiqci-vtt-qiskit` and `fiqci-vtt-cirq` provide pre-made python environments to directly run on Helmi.
2121
If you wish to add your own python packages to the pre-made python environment you can do so with `python -m pip install --user package`.
2222

2323

@@ -49,9 +49,9 @@ Here is an example batch script to submit jobs on Helmi
4949
module use /appl/local/quantum/modulefiles
5050

5151
# uncomment correct line:
52-
# module load helmi_qiskit
52+
# module load fiqci-vtt-qiskit
5353
# or
54-
# module load helmi_cirq
54+
# module load fiqci-vtt-cirq
5555

5656
python your_python_script.py
5757
```
@@ -69,7 +69,7 @@ The `helmi_*` module sets up the correct python environment to use Qiskit or Cir
6969

7070
### Qiskit
7171

72-
To load the Qiskit module use `module load helmi_qiskit`.
72+
To load the Qiskit module use `module load fiqci-vtt-qiskit`.
7373

7474
In Qiskit python scripts you will need to include the following:
7575

@@ -103,7 +103,7 @@ print(counts)
103103

104104
### Cirq
105105

106-
To load the Cirq module use `module load helmi_cirq`.
106+
To load the Cirq module use `module load fiqci-vtt-cirq`.
107107

108108
```python
109109
import os
@@ -222,7 +222,7 @@ It is recommended to use the 'Advanced settings'. Under the 'Custom init' option
222222

223223
```bash
224224
module use /appl/local/quantum/modulefiles
225-
module load helmi_qiskit # or module load helmi_cirq
225+
module load fiqci-vtt-qiskit # or module load fiqci-vtt-cirq
226226
```
227227

228228
<p align="center">

0 commit comments

Comments
 (0)