qraise
======

Raise one or more vQPUs with a well defined configuration.

The ``qraise`` command is used to deploy a set of virtual QPUs with a given configuration,
including computational resources, backend selection, and communication capabilities.
The raised vQPUs can subsequently be used to execute quantum circuits within the CUNQA
framework.

Synopsis
--------

.. code-block:: bash

   qraise [OPTIONS]

Options
-------

General deployment options
~~~~~~~~~~~~~~~~~~~~~~~~~~

``-n, --num_qpus <int>``
    Number of QPUs to be raised.
    Default: ``0``

``-t, --time <string>``
    Time during which the QPUs will remain active.
    Default: empty string.

``-c, --cores <int>``
    Number of CPU cores assigned to each QPU.
    Default: ``2``

``-p, --partition <string>``
    Partition requested for the QPUs.

``--mem-per-qpu <int>``
    Amount of memory (in GB) assigned to each QPU.

``-N, --n_nodes <int>``
    Number of compute nodes used to deploy the QPUs.
    Default: ``1``

``--node_list <string>``
    List of nodes where the QPUs will be deployed.
    Multiple nodes can be specified at a time.

``--qpus_per_node <int>``
    Number of QPUs deployed on each node.

Backend and simulation options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``-b, --backend <string>``
    Path to the backend configuration file.

``-sim, --simulator <string>``
    Selects simulator responsible for running the simulations.
    Default: ``Aer``

Noise model options
~~~~~~~~~~~~~~~~~~~

``--noise-prop, --noise-properties <string>``  
    Path to the noise properties JSON file.  
    Only supported when using the ``Aer`` simulator.

``-fq, --fakeqmio <string>``  
    Raise a FakeQmio backend from a calibration file.  
    If no value is provided, the default calibration set ``last_calibrations`` is used.
    It can only be used when executing in CESGA.

``--no-thermal-relaxation``  
    Deactivate thermal relaxation in a noisy backend.  
    Default: ``false``

``--no-readout-error``  
    Deactivate readout error in a noisy backend.  
    Default: ``false``

``--no-gate-error``  
    Deactivate gate error in a noisy backend.  
    Default: ``false``


Grouping and communication options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``--family_name <string>``
    Name used to identify the group of QPUs that were raised together.
    Default: ``default``

``--co-located``
    Enable co-located mode.
    If set, the vQPU can be accesed from any node.
    Otherwise, the user can only access it from the node it is deployed on.

``--classical_comm``
    Enable classical communications between QPUs.

``--quantum_comm``
    Enable quantum communications between QPUs.

GPU execution
~~~~~~~~~~~~~~~~~~~~~~
``--gpu``
    Enable GPU execution. The quantum simulation will be performed on GPU.


Real QPU
~~~~~~~~~~~~~~~~~~~~~~
``--qmio``
    *Deploys* the real quantum computer QMIO located at CESGA's installations, allowing hybrid DQC infrastructures.


Basic usage
-----------

Command that deploys 2 vQPUs with classical communications, for 10 minutes and accessible from any node:

.. code-block:: bash

   qraise -n 2 -t 00:10:00 --classical_comm --co-located

Notes
-----

- Some options are backend- or simulator-specific and may not be supported in all execution
  environments.
- Invalid or incompatible combinations of options may result in an error at deployment time.