* Switch examples/tutorial 4.3_parameter-sweeping -> 4.4_multi-node a…

…nd the reverse * Added clinks to API documentation * Fix for configurations now inheriting from netbuilder not showing documentation in API documentation
QuTech-Delft · Mar 5, 2024 · 3864cf8 · 3864cf8
1 parent d9f79d7
commit 3864cf8
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 12 deletions.
diff --git a/docs/source/modules/configurations.rst b/docs/source/modules/configurations.rst
@@ -39,4 +39,13 @@ Link configurations
 .. toctree::
     :maxdepth: 2
 
-    configurations/link_configurations
+    configurations/link_configurations
+
+
+CLink configurations
++++++++++++++++++++++
+
+.. toctree::
+    :maxdepth: 2
+
+    configurations/clink_configurations
diff --git a/docs/source/modules/configurations/clink_configurations.rst b/docs/source/modules/configurations/clink_configurations.rst
@@ -0,0 +1,21 @@
+CLink Configurations
+=====================
+
+
+ .. autoclass:: squidasm.run.stack.config.CLinkConfig
+    :members:
+    :undoc-members:
+    :member-order: bysource
+
+
+ .. autoclass:: squidasm.run.stack.config.InstantCLinkConfig
+    :members:
+    :undoc-members:
+    :inherited-members: BaseModel
+    :member-order: bysource
+
+ .. autoclass:: squidasm.run.stack.config.DefaultCLinkConfig
+    :members:
+    :undoc-members:
+    :inherited-members: BaseModel
+    :member-order: bysource
diff --git a/docs/source/modules/configurations/link_configurations.rst b/docs/source/modules/configurations/link_configurations.rst
@@ -11,9 +11,11 @@ Link Configurations
  .. autoclass:: squidasm.run.stack.config.DepolariseLinkConfig
     :members:
     :undoc-members:
+    :inherited-members: BaseModel
     :member-order: bysource
 
  .. autoclass:: squidasm.run.stack.config.HeraldedLinkConfig
     :members:
     :undoc-members:
+    :inherited-members: BaseModel
     :member-order: bysource
diff --git a/docs/source/modules/configurations/stack_configurations.rst b/docs/source/modules/configurations/stack_configurations.rst
@@ -21,6 +21,7 @@ The rotation gates will rotate the qubit around the specified axis with a given
  .. autoclass:: squidasm.run.stack.config.GenericQDeviceConfig
     :members:
     :undoc-members:
+    :inherited-members: BaseModel
     :member-order: bysource
 
 NV QDevice
@@ -44,4 +45,5 @@ The topology of the NV qdevice only allows for CXDIR and CYDIR gates between the
  .. autoclass:: squidasm.run.stack.config.NVQDeviceConfig
     :members:
     :undoc-members:
+    :inherited-members: BaseModel
     :member-order: bysource
diff --git a/docs/source/tutorial/section4_NetworkConfiguration.rst b/docs/source/tutorial/section4_NetworkConfiguration.rst
@@ -246,7 +246,7 @@ Our goal is to use ``run_simulation.py`` to modify the network of ``config.yaml`
 replace its link with a depolarize link, perform multiple simulations with varying fidelity for the link
 and generate an graph of the fidelity vs error rate.
 
-.. literalinclude:: ../../../examples/tutorial/4.3_parameter-sweeping/run_simulation.py
+.. literalinclude:: ../../../examples/tutorial/4.4_parameter-sweeping/run_simulation.py
     :language: python
     :caption: examples/tutorial/4.3_parameter-sweeping/run_simulation.py
     :emphasize-lines: 12-20, 26-27
@@ -265,7 +265,7 @@ We then load in the configuration options for the depolarise link:
 
 This creates the ``DepolariseLinkConfig`` object based on the parameters in the file ``depolarise_link_config.yaml``:
 
-.. literalinclude:: ../../../examples/tutorial/4.3_parameter-sweeping/depolarise_link_config.yaml
+.. literalinclude:: ../../../examples/tutorial/4.4_parameter-sweeping/depolarise_link_config.yaml
     :language: yaml
     :caption: examples/tutorial/4.3_parameter-sweeping/depolarise_link_config.yaml
 

diff --git a/...es/tutorial/4.4_multi-node/application.py → ...es/tutorial/4.3_multi-node/application.py b/...es/tutorial/4.4_multi-node/application.py → ...es/tutorial/4.3_multi-node/application.py
diff --git a/...tutorial/4.4_multi-node/run_simulation.py → ...tutorial/4.3_multi-node/run_simulation.py b/...tutorial/4.4_multi-node/run_simulation.py → ...tutorial/4.3_multi-node/run_simulation.py
diff --git a/...ial/4.3_parameter-sweeping/application.py → ...ial/4.4_parameter-sweeping/application.py b/...ial/4.3_parameter-sweeping/application.py → ...ial/4.4_parameter-sweeping/application.py
diff --git a/...torial/4.3_parameter-sweeping/config.yaml → ...torial/4.4_parameter-sweeping/config.yaml b/...torial/4.3_parameter-sweeping/config.yaml → ...torial/4.4_parameter-sweeping/config.yaml
diff --git a/...eter-sweeping/depolarise_link_config.yaml → ...eter-sweeping/depolarise_link_config.yaml b/...eter-sweeping/depolarise_link_config.yaml → ...eter-sweeping/depolarise_link_config.yaml
diff --git a/.../4.3_parameter-sweeping/run_simulation.py → .../4.4_parameter-sweeping/run_simulation.py b/.../4.3_parameter-sweeping/run_simulation.py → .../4.4_parameter-sweeping/run_simulation.py
diff --git a/squidasm/run/stack/build.py b/squidasm/run/stack/build.py
@@ -1,13 +1,12 @@
 from __future__ import annotations
 
-from typing import Dict, TYPE_CHECKING
+from typing import Dict
 
 from netsquid_netbuilder.base_configs import NetworkConfig
 from netsquid_netbuilder.builder.network_builder import NetworkBuilder, NodeBuilder
 from netsquid_netbuilder.run import get_default_builder
 
-if TYPE_CHECKING:
-    from squidasm.sim.stack.stack import StackNode
+from squidasm.sim.stack.stack import StackNode
 
 
 class StackNodeBuilder(NodeBuilder):

diff --git a/squidasm/run/stack/config.py b/squidasm/run/stack/config.py
@@ -11,11 +11,11 @@
 
 
 class GenericQDeviceConfig(netbuilder_qdevices.GenericQDeviceConfig):
-    pass
+    __doc__ = netbuilder_qdevices.GenericQDeviceConfig.__doc__
 
 
 class NVQDeviceConfig(netbuilder_qdevices.NVQDeviceConfig):
-    pass
+    __doc__ = netbuilder_qdevices.NVQDeviceConfig.__doc__
 
 
 class StackConfig(YamlLoadable):
@@ -43,19 +43,19 @@ def perfect_generic_config(cls, name: str) -> StackConfig:
 
 
 class DepolariseLinkConfig(netbuilder_links.DepolariseLinkConfig):
-    pass
+    __doc__ = netbuilder_links.DepolariseLinkConfig.__doc__
 
 
 class HeraldedLinkConfig(netbuilder_links.HeraldedDoubleClickLinkConfig):
-    pass
+    __doc__ = netbuilder_links.HeraldedDoubleClickLinkConfig.__doc__
 
 
 class InstantCLinkConfig(netbuilder_clinks.InstantCLinkConfig):
-    pass
+    __doc__ = netbuilder_clinks.InstantCLinkConfig.__doc__
 
 
 class DefaultCLinkConfig(netbuilder_clinks.DefaultCLinkConfig):
-    pass
+    __doc__ = netbuilder_clinks.DefaultCLinkConfig.__doc__
 
 
 class LinkConfig(YamlLoadable):