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

Open
wants to merge 46 commits into
base: master
Choose a base branch
from
Open

Conversation

TheKharleeci
Copy link
Contributor

@TheKharleeci TheKharleeci commented Jun 24, 2025

Proposed changes

  • Adds instructions for using VTT Q50
  • Updates documentation to include VTT Q50
  • Removes kvasi docs
  • preview page

Checklist before requesting a review

@TheKharleeci TheKharleeci requested review from JMuff22 and olmuk June 24, 2025 07:04
@rkronberg
Copy link
Collaborator

Why is Kvasi being removed from Docs? It still seems to be a productized service of CSC, and service catalog entry https://research.csc.fi/service/kvasi-the-quantum-learning-machine/ still links to docs (e.g. link to service and user guide)

@TheKharleeci
Copy link
Contributor Author

Why is Kvasi being removed from Docs? It still seems to be a productized service of CSC, and service catalog entry https://research.csc.fi/service/kvasi-the-quantum-learning-machine/ still links to docs (e.g. link to service and user guide)

Kvasi will be decommissioned on 31 August 2025, and we are gradually phasing it out by removing the documentation.

@TheKharleeci TheKharleeci marked this pull request as ready for review June 25, 2025 21:52
@mpjohans
Copy link
Contributor

There's two failed checks. Please check that these are irrelevant. If so, ready to merge

@TheKharleeci
Copy link
Contributor Author

TheKharleeci commented Jun 26, 2025

There's two failed checks. Please check that these are irrelevant. If so, ready to merge

Yes, I need to update the nav and remove references to kvasi docs

@rkronberg
Copy link
Collaborator

@mpjohans note that there will be broken links pointing from https://research.csc.fi/service/kvasi-the-quantum-learning-machine/ when the Kvasi docs are removed. This needs to be fixed in CSC External Service Catalog. Lassi Lager and Johanna Laiho-Kauranne can help.

@TheKharleeci TheKharleeci requested a review from QuantuMikey June 26, 2025 17:58
@TheKharleeci
Copy link
Contributor Author

Broken references fixed!

@QuantuMikey
Copy link
Contributor

QuantuMikey commented Jun 27, 2025

I think it looks nice but to make it easier can we make 3 tabs for the "First quantum jobs" page... 1 tab for general instructions/examples for running a circuit on only Helmi, 1 tab for only Q50, and 1 tab for running a circuit on both Helmi and Q50

similar to how we have tabs for Puhti, Mahti, and LUMI on this page for quantum simulations using qiskit...

https://docs.csc.fi/apps/qiskit/

It is my opinion that the simpler it is for a researcher to use our services the better for them and less load on us having to service tickets where they may encounter "issues" on using our service.

If it is too much work right now, maybe we can push out another version soon after this version is published.

Other than this comment I think all the pages are nice and I like how the structure under "Quantum computing" has been simplified.

@TheKharleeci
Copy link
Contributor Author

I think it looks nice but to make it easier can we make 3 tabs for the "First quantum jobs" page... 1 tab for general instructions/examples for running a circuit on only Helmi, 1 tab for only Q50, and 1 tab for running a circuit on both Helmi and Q50

similar to how we have tabs for Puhti, Mahti, and LUMI on this page for quantum simulations using qiskit...

https://docs.csc.fi/apps/qiskit/

It is my opinion that the simpler it is for a researcher to use our services the better for them and less load on us having to service tickets where they may encounter "issues" on using our service.

If it is too much work right now, maybe we can push out another version soon after this version is published.

Other than this comment I think all the pages are nice and I like how the structure under "Quantum computing" has been simplified.

I agree this is a good suggestion, it would help make the documentation clearer and more concise. However, given my current time constraints, it might be better handled in a separate PR. Of course, anyone is welcome to update this PR with this feature if they’d like.

@JooNiv
Copy link

JooNiv commented Jun 27, 2025

I think it looks nice but to make it easier can we make 3 tabs for the "First quantum jobs" page... 1 tab for general instructions/examples for running a circuit on only Helmi, 1 tab for only Q50, and 1 tab for running a circuit on both Helmi and Q50
similar to how we have tabs for Puhti, Mahti, and LUMI on this page for quantum simulations using qiskit...
https://docs.csc.fi/apps/qiskit/
It is my opinion that the simpler it is for a researcher to use our services the better for them and less load on us having to service tickets where they may encounter "issues" on using our service.
If it is too much work right now, maybe we can push out another version soon after this version is published.
Other than this comment I think all the pages are nice and I like how the structure under "Quantum computing" has been simplified.

I agree this is a good suggestion, it would help make the documentation clearer and more concise. However, given my current time constraints, it might be better handled in a separate PR. Of course, anyone is welcome to update this PR with this feature if they’d like.

I can take this

@TheKharleeci
Copy link
Contributor Author

@rkronberg I think we can update the intermediate section. Let me know when I need to update the redirects. Thanks

TheKharleeci and others added 2 commits June 27, 2025 16:19
@TheKharleeci TheKharleeci requested a review from rkronberg June 27, 2025 14:16
@rkronberg
Copy link
Collaborator

@rkronberg I think we can update the intermediate section. Let me know when I need to update the redirects. Thanks

The following pages have either been deleted or URL changed:

  • docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md
  • docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md
  • docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md
  • docs/computing/quantum-computing/helmi/fiqci-partition.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-projects.md -> deleted
  • docs/computing/quantum-computing/kvasi/kvasi-billing.md -> deleted
  • docs/computing/quantum-computing/kvasi/kvasi.md -> deleted

You can set redirects in mkdocs.yml. Let me know if you need help!

@TheKharleeci
Copy link
Contributor Author

TheKharleeci commented Jun 27, 2025

  • docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md
  • docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md
  • docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md
  • docs/computing/quantum-computing/helmi/fiqci-partition.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-projects.md -> deleted

I set redirect for these:
docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md
docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md
docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md
docs/computing/quantum-computing/helmi/fiqci-partition.md -> computing/quantum-computing/fiqci-partition.md
docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> computing/quantum-computing/access.md
docs/computing/quantum-computing/helmi/helmi-projects.md -> computing/quantum-computing/projects.md

kvasi has been deleted. Do we need a redirect for it?

@rkronberg
Copy link
Collaborator

  • docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md
  • docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md
  • docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md
  • docs/computing/quantum-computing/helmi/fiqci-partition.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-projects.md -> deleted

I set redirect for these: docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md docs/computing/quantum-computing/helmi/fiqci-partition.md -> computing/quantum-computing/fiqci-partition.md docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> computing/quantum-computing/access.md docs/computing/quantum-computing/helmi/helmi-projects.md -> computing/quantum-computing/projects.md

kvasi has been deleted. Do we need a redirect for it?

At least Kvasi service page in research.csc.fi still links to Kvasi pages. To avoid 404 errors, I'd propose setting a redirect e.g. to the Quantum computing Overview page.

@TheKharleeci
Copy link
Contributor Author

  • docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md
  • docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md
  • docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md
  • docs/computing/quantum-computing/helmi/fiqci-partition.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> deleted
  • docs/computing/quantum-computing/helmi/helmi-projects.md -> deleted

I set redirect for these: docs/computing/helmi/first-quantum-job.md -> docs/computing/quantum-computing/first-quantum-job.md docs/computing/helmi/running-on-helmi.md -> docs/computing/quantum-computing/running-quantum-jobs.md docs/computing/helmi/helmi-specs.md -> docs/computing/quantum-computing/specs.md docs/computing/quantum-computing/helmi/fiqci-partition.md -> computing/quantum-computing/fiqci-partition.md docs/computing/quantum-computing/helmi/helmi-from-lumi.md -> computing/quantum-computing/access.md docs/computing/quantum-computing/helmi/helmi-projects.md -> computing/quantum-computing/projects.md
kvasi has been deleted. Do we need a redirect for it?

At least Kvasi service page in research.csc.fi still links to Kvasi pages. To avoid 404 errors, I'd propose setting a redirect e.g. to the Quantum computing Overview page.

Thanks for pointing out. I've updated the redirect for kvasi now.

@TheKharleeci
Copy link
Contributor Author

PR Ready to be merged! Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants