oqtant 0.16.2

Oqtant Desktop Suite

Oqtant

🚀 Quick Install

pip install oqtant

🧭 Introduction

This API contains tools to:

• Access all the functionality of the Oraqle Web App (https://albert-dev.coldquanta.com)

  • BARRIER (Barrier Manipulator) jobs
  • BEC (Ultracold Matter) jobs

• Build parameterized (i.e. optimization) experiments using OqtantJobs

• Submit and retrieve OqtantJob results

🤖 How Oqtant Works

• Construct a single or list of jobs using the OqtantJob class

  • 1D parameter sweeps are supported

• Run a single or list of jobs using run_jobs(). The jobs are submitted to run on hardware in FIFO queue.

  • job lists are run sequentially (uninterrupted) unless list exceeds 30 jobs

• As jobs run, OqtantJob objects are created automatically and stored in active_jobs.

  • View these jobs with see_active_jobs()
  • These jobs are available until the python session ends.

• To operate on jobs from a current or previous session, load them into active_jobs with

  • load_job_from_id(), load_job_from_id_list(), load_job_from_file(), load_job_from_file_list()

• To analyze job objects and use Oqtant's job analysis library, reference the OqtantJob class documentation.

Need help? Found a bug? Contact [e-mail] for support. Thank you!

📓 Documentation

• Getting started (installation, setting up the environment, how to run the walkthrough notebooks)
• Walkthroughs (demos for creating and submitting jobs)
• Oraqle API docs
• Job Analysis docs