Skip to content

update job submit instructions #2623

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.

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 46 commits into from
Jun 30, 2025
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
2ad820d
update job submit instructions
TheKharleeci Jun 24, 2025
c37e0b7
update technical details
TheKharleeci Jun 24, 2025
abe2e5a
update overview
TheKharleeci Jun 25, 2025
6e77040
update broken references
TheKharleeci Jun 26, 2025
5018353
Add note on q50 topology
TheKharleeci Jun 26, 2025
59db3cc
Merge branch 'master' into rewrite-quantum-docs
TheKharleeci Jun 26, 2025
ffd518c
update topology image
TheKharleeci Jun 26, 2025
a897053
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
TheKharleeci Jun 26, 2025
0218a14
update sample job scripts
TheKharleeci Jun 27, 2025
fd1ea5c
add separate tables for backends
JooNiv Jun 27, 2025
6681221
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
JooNiv Jun 27, 2025
ec9220a
table tabs for qiskit and cirq examples
JooNiv Jun 27, 2025
d50badd
Fix errors in transpile / decompose section
JooNiv Jun 27, 2025
f77e4cc
update sample scripts
TheKharleeci Jun 27, 2025
ace22e8
table tabs for batch script
JooNiv Jun 27, 2025
1226e25
table tabs for batch and python scripts
JooNiv Jun 27, 2025
195469c
wording
JooNiv Jun 27, 2025
f5f906b
typo
JooNiv Jun 27, 2025
23a71e2
table tabs for metadata
JooNiv Jun 27, 2025
3cb602c
Add q50 reference to fom, fix link
JooNiv Jun 27, 2025
5c37076
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
JooNiv Jun 27, 2025
dea8424
typo
JooNiv Jun 27, 2025
9014364
Merge branch 'master' into rewrite-quantum-docs
TheKharleeci Jun 27, 2025
17f45fc
update running jobs interactively
TheKharleeci Jun 27, 2025
305a361
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
TheKharleeci Jun 27, 2025
252481e
add redirects
TheKharleeci Jun 27, 2025
8947dd9
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
JooNiv Jun 27, 2025
11b5b0f
Update mkdocs.yml
TheKharleeci Jun 27, 2025
c50845e
Merge branch 'rewrite-quantum-docs' of github.com:CSCfi/csc-user-guid…
JooNiv Jun 27, 2025
24c5c41
Update docs/accounts/index.md
TheKharleeci Jun 27, 2025
7a307bb
Merge branch 'rewrite-quantum-docs' of github.com:CSCfi/csc-user-guid…
JooNiv Jun 27, 2025
6c2e4a9
update images
TheKharleeci Jun 27, 2025
ea7b231
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
TheKharleeci Jun 27, 2025
1e85401
update broken links
TheKharleeci Jun 27, 2025
6ada6de
fix nav structure
JooNiv Jun 27, 2025
208b3ec
update accounts links
TheKharleeci Jun 27, 2025
026b718
Merge branch 'rewrite-quantum-docs' of github.com:CSCfi/csc-user-guid…
JooNiv Jun 27, 2025
8de0e01
Merge branch 'rewrite-quantum-docs' of github.com:CSCfi/csc-user-guid…
JooNiv Jun 27, 2025
83cba41
update running-jobs
TheKharleeci Jun 27, 2025
a6880af
Merge branch 'rewrite-quantum-docs' of github.com:CSCfi/csc-user-guid…
JooNiv Jun 27, 2025
66c9264
formatting, fix images
JooNiv Jun 27, 2025
15d6f6e
formatting
JooNiv Jun 27, 2025
c4d8f2b
add kvasi redirect
TheKharleeci Jun 27, 2025
f80cb77
Merge branch 'rewrite-quantum-docs' of https://github.com/CSCfi/csc-u…
TheKharleeci Jun 27, 2025
9da33c4
update helmi topology diagram
TheKharleeci Jun 27, 2025
41fed6d
update interactive job instruction
TheKharleeci Jun 27, 2025
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
1 change: 0 additions & 1 deletion docs/accounts/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ at research.csc.fi.
data stored in Allas is billed.
* [Pouta billing](../cloud/pouta/accounting.md)
* [Rahti billing](../cloud/rahti/billing.md)
* [Kvasi billing](../computing/quantum-computing/kvasi/kvasi-billing.md)
* [SD Connect and SD Desktop billing](../data/sensitive-data/sd-use-case-new-user-project-manager.md#sd-connect-bu-consumption)


Expand Down
2 changes: 1 addition & 1 deletion docs/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Project Manager is typically a leader of a research team or other senior res
* **Billing Units** (BUs) are used to allocate resources to users' projects. You can apply for Billing Units in [MyCSC](https://my.csc.fi) portal and CSC grants BUs to projects. [Usage consumes billing units](billing.md) but **no actual payment** is required.
However, the amount of billing units must always remain positive.

* **LUMI projects** used to manage access to LUMI and the resources provided by it. LUMI projects are restricted to LUMI environment only (LUMI-C, LUMI-G etc.). Finnish LUMI projects are fixed in time and resources, and the total resources must be defined already in the project application. Lumi projects are also used for [Helmi quantum computer](../computing/quantum-computing/helmi/helmi-from-lumi.md). For further information please see [these instructions](https://www.lumi-supercomputer.eu/get-started-2021/users-in-finland/){:target="_blank"}.
* **LUMI projects** used to manage access to LUMI and the resources provided by it. LUMI projects are restricted to LUMI environment only (LUMI-C, LUMI-G etc.). Finnish LUMI projects are fixed in time and resources, and the total resources must be defined already in the project application. Lumi projects are also used for [Fiqci quantum computers](../computing/quantum-computing/quantum-computers/access.md). For further information please see [these instructions](https://www.lumi-supercomputer.eu/get-started-2021/users-in-finland/){:target="_blank"}.

* **My.csc.fi portal** MyCSC is the self-service CSC customer portal for research and education customers and end-users. MyCSC is also available for any other CSC customer or end-user, if they have CSC user accounts according to the CSCID policies.
MyCSC portal offers users the functionality for registering CSC user accounts, creating computing or data projects, adding members to projects, and applying resources for projects. Users can also manage their projects and project lifecycles through MyCSC, and they can see the resources consumption and amount of stored data there.
Expand Down
19 changes: 11 additions & 8 deletions docs/apps/cirq-on-iqm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ catalog:
# Cirq-on-iqm

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

## Available

Currently supported [cirq-on-iqm](https://iqm-finland.github.io/cirq-on-iqm/) versions:

| Version | Module | LUMI | Notes |
|:--------|:-------------------------------------|:-----:|-----------------|
| 15.2 | `fiqci-vtt-cirq/15.2` | X | |
| 16.2 | `fiqci-vtt-cirq/16.2` | X | |


All modules are based on Tykky using LUMI-container-wrapper.
Expand Down Expand Up @@ -61,14 +61,14 @@ module avail fiqci-vtt-cirq

### Example batch script

Example batch script for running a quantum job on Helmi:
Example batch script for running a quantum job:

```bash title="LUMI"
#!/bin/bash -l

#SBATCH --job-name=helmijob # Job name
#SBATCH --output=helmijob.o%j # Name of stdout output file
#SBATCH --error=helmijob.e%j # Name of stderr error file
#SBATCH --job-name=quantumjob # Job name
#SBATCH --output=quantumjob.o%j # Name of stdout output file
#SBATCH --error=quantumjob.e%j # Name of stderr error file
#SBATCH --partition=q_fiqci # Partition (queue) name
#SBATCH --ntasks=1 # One task (process)
#SBATCH --cpus-per-task=1 # Number of cores (threads)
Expand All @@ -79,6 +79,9 @@ Example batch script for running a quantum job on Helmi:
module use /appl/local/quantum/modulefiles
module load fiqci-vtt-cirq

export DEVICES=("Q5") #export DEVICES=("Q5" "Q50") to use Helmi and Q50
source /appl/local/quantum/fiqci_vtt/scripts/run_script.sh

python -u quantum_job.py
```

Expand All @@ -87,4 +90,4 @@ Submit the script with `sbatch <script_name>.sh`.
## More information

- [Cirq-IQM documentation](https://iqm-finland.github.io/cirq-on-iqm/user_guide.html)
- [Quantum-Computing](../computing/quantum-computing/helmi/running-on-helmi.md)
- [Quantum-Computing](../computing/quantum-computing/quantum-computers/running-quantum-jobs.md)
19 changes: 10 additions & 9 deletions docs/apps/qiskit-on-iqm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ catalog:
# Qiskit-on-iqm

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


## Available
Expand All @@ -25,7 +25,7 @@ versions:

| Version | Module | LUMI | Notes |
|:--------|:-------------------------------------|:-----:|-----------------|
| 15.5 | `fiqci-vtt-qiskit/15.5` | X | |
| 17.8 | `fiqci-vtt-qiskit/17.8` | X | |

All modules are based on Tykky using LUMI-container-wrapper.
Wrapper scripts have been provided so that common commands such as `python`,
Expand Down Expand Up @@ -62,14 +62,14 @@ module avail fiqci-vtt-qiskit

### Example batch script

Example batch script for running a quantum job on Helmi:
Example batch script for running a quantum job:

```bash title="LUMI"
#!/bin/bash -l

#SBATCH --job-name=helmijob # Job name
#SBATCH --output=helmijob.o%j # Name of stdout output file
#SBATCH --error=helmijob.e%j # Name of stderr error file
#SBATCH --job-name=quantumjob # Job name
#SBATCH --output=quantumjob.o%j # Name of stdout output file
#SBATCH --error=quantumjob.e%j # Name of stderr error file
#SBATCH --partition=q_fiqci # Partition (queue) name
#SBATCH --ntasks=1 # One task (process)
#SBATCH --cpus-per-task=1 # Number of cores (threads)
Expand All @@ -79,7 +79,8 @@ Example batch script for running a quantum job on Helmi:

module use /appl/local/quantum/modulefiles
module load fiqci-vtt-qiskit

export DEVICES=("Q5") #export DEVICES=("Q5" "Q50") to use Helmi and Q50
source /appl/local/quantum/fiqci_vtt/scripts/run_script.sh
python -u quantum_job.py
```

Expand All @@ -88,4 +89,4 @@ Submit the script with `sbatch <script_name>.sh`.
## More information

- [Qiskit-IQM documentation](https://iqm-finland.github.io/qiskit-on-iqm/)
- [Quantum-Computing](../computing/quantum-computing/helmi/running-on-helmi.md)
- [Quantum-Computing](../computing/quantum-computing/quantum-computers/running-quantum-jobs.md)
4 changes: 2 additions & 2 deletions docs/apps/qiskit.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ catalog:

Qiskit is an open-source software for working with quantum computers at the level of circuits, pulses, and algorithms.
This page contains information in regard to running Quantum simulations using qiskit inside of a singularity container.
For information pertaining to running jobs on Helmi using qiskit please refer to this documentation:
[Running on Helmi](../computing/quantum-computing/helmi/running-on-helmi.md).
For information pertaining to running jobs on the physical quantum computers using qiskit please refer to this documentation:
[Running quantum jobs](../computing/quantum-computing/quantum-computers/running-quantum-jobs.md).

!!! info "News"
**19.02.2025** Installed `qiskit/1.3.2` in a singularity container on LUMI with all major Qiskit packages and
Expand Down
2 changes: 1 addition & 1 deletion docs/computing/available-systems.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Systems

CSC's computing environment consists of supercomputers Puhti and
Mahti, and the quantum learning machine Kvasi. Puhti and Mahti have a
Mahti. Puhti and Mahti have a
fairly similar compute environment, and there is a wide range of
workloads that can utilize both efficiently. At the same time their
hardware is different, and this makes some worklods uniquely suitable
Expand Down
52 changes: 0 additions & 52 deletions docs/computing/quantum-computing/helmi/fiqci-partition.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/computing/quantum-computing/helmi/helmi-from-lumi.md

This file was deleted.

40 changes: 0 additions & 40 deletions docs/computing/quantum-computing/helmi/helmi-projects.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/computing/quantum-computing/kvasi/kvasi-billing.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/computing/quantum-computing/kvasi/kvasi.md

This file was deleted.

Loading