diff --git a/docs/examples/DataSet/Working with snapshots.ipynb b/docs/examples/DataSet/Working with snapshots.ipynb index fe3df8d1c19..156fa5668cc 100644 --- a/docs/examples/DataSet/Working with snapshots.ipynb +++ b/docs/examples/DataSet/Working with snapshots.ipynb @@ -277,7 +277,7 @@ "\n", "Experimental setups are large, and instruments tend to be quite complex in that they comprise many parameters and other stateful parts. It would be very time-consuming for the user to manually go through every instrument and parameter, and collect the snapshot data.\n", "\n", - "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a [Station object](../Station.ipynb) ([nbviewer.jupyter.org link](https://nbviewer.jupyter.org/github/QCoDeS/Qcodes/tree/main/docs/examples/Station.ipynb)). In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n", + "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a [Station object](../basic_examples/Station.ipynb) ([nbviewer.jupyter.org link](https://nbviewer.jupyter.org/github/microsoft/Qcodes/tree/main/docs/examples/basic_examples/Station.ipynb)). In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n", "\n", "Note that in this article the focus is on the snapshot feature of the QCoDeS `Station`, while it has some other features (also some legacy once)." ] diff --git a/docs/examples/DataSet/index.rst b/docs/examples/DataSet/index.rst new file mode 100644 index 00000000000..49d939436c0 --- /dev/null +++ b/docs/examples/DataSet/index.rst @@ -0,0 +1,9 @@ +DataSet +------- + +.. toctree:: + :glob: + + * + Real_instruments/* + Cache/* diff --git a/docs/examples/Parameters/index.rst b/docs/examples/Parameters/index.rst new file mode 100644 index 00000000000..edae1c5c5df --- /dev/null +++ b/docs/examples/Parameters/index.rst @@ -0,0 +1,9 @@ +Parameters +---------- + +.. include:: readme.txt + +.. toctree:: + :glob: + + * diff --git a/docs/examples/15_minutes_to_QCoDeS.ipynb b/docs/examples/basic_examples/15_minutes_to_QCoDeS.ipynb similarity index 98% rename from docs/examples/15_minutes_to_QCoDeS.ipynb rename to docs/examples/basic_examples/15_minutes_to_QCoDeS.ipynb index 67c1bcc4c2e..06440d73966 100644 --- a/docs/examples/15_minutes_to_QCoDeS.ipynb +++ b/docs/examples/basic_examples/15_minutes_to_QCoDeS.ipynb @@ -6,7 +6,7 @@ "source": [ "# 15 minutes to QCoDeS\n", "\n", - "This short introduction is aimed for potential and new users to get the feel of the software. This is a fully functioning Jupyter notebook that will execute simple measurements using dummy instruments. Before you start with your first code using QCoDeS, make sure you have properly set up the Python environment as explained in [this document](../start/index.rst#installation). If you would like to follow this as an interactive notebook, you may [download it from github](https://github.com/QCoDeS/Qcodes/blob/main/docs/examples/15_minutes_to_QCoDeS.ipynb) to run on your local system, or you may use~ the \"launch binder\" link to use it via a web interface." + "This short introduction is aimed for potential and new users to get the feel of the software. This is a fully functioning Jupyter notebook that will execute simple measurements using dummy instruments. Before you start with your first code using QCoDeS, make sure you have properly set up the Python environment as explained in [this document](../../start/index.rst#installation). If you would like to follow this as an interactive notebook, you may [download it from github](https://github.com/microsoft/Qcodes/blob/main/docs/examples/basic_examples/15_minutes_to_QCoDeS.ipynb) to run on your local system, or you may use~ the \"launch binder\" link to use it via a web interface." ] }, { @@ -26,7 +26,7 @@ "source": [ "## Installation\n", "\n", - "QCoDeS is readily installed via pip or conda package managers in your preferred environment. These are other installation options are further detailed [in our installation guide](../start/index.rst#installation).\n", + "QCoDeS is readily installed via pip or conda package managers in your preferred environment. These are other installation options are further detailed [in our installation guide](../../start/index.rst#installation).\n", "\n", "Install via pip:\n", "\n", @@ -84,7 +84,7 @@ "source": [ "## Instruments\n", "\n", - "`Instrument` class in QCoDeS is responsible for holding connections to hardware and controlling the instruments by its built in methods. For more information on instrument class we refer to the [detailed description here](writing_drivers/Instruments.ipynb) or the corresponding [api documentation](../api/instrument/index.rst). \n", + "`Instrument` class in QCoDeS is responsible for holding connections to hardware and controlling the instruments by its built in methods. For more information on instrument class we refer to the [detailed description here](../writing_drivers/Instruments.ipynb) or the corresponding [api documentation](../../api/instrument/index.rst). \n", "\n", "Let us, now, create two dummy instruments: a digital-to-analog converter (`dac`) with two channels, and a digital multimeter (`dmm`) to measure the signals produced: \n" ] @@ -145,7 +145,7 @@ "source": [ "## Parameters\n", "\n", - "A QCoDeS `Parameter` is a value from an instrument that may get and/or set values by methods. Intuitively this is how QCoDeS communicates with most instrumentation, for example a digital multimeter contains settings (e.g. mode, range) and provide data (e.g. voltage, current). These methods are defined by [instrument drivers](index.rst#drivers), that utilize the [parameter API](../api/parameters/index.rst). \n", + "A QCoDeS `Parameter` is a value from an instrument that may get and/or set values by methods. Intuitively this is how QCoDeS communicates with most instrumentation, for example a digital multimeter contains settings (e.g. mode, range) and provide data (e.g. voltage, current). These methods are defined by [instrument drivers](../driver_examples/index.rst), that utilize the [parameter API](../../api/parameters/index.rst). \n", "\n", "In this example we are using dummy instruments with trivial `set` and `get` methods to generate synthetic data. \n", "\n", @@ -165,13 +165,13 @@ "\n", "For convenience QCoDeS provides a variety of parameter classes built in to accommodate a range of instruments: \n", "\n", - " - `Parameter` : Represents a single value at a given time (e.g. voltage, current), please refer to the [example parameter notebook](Parameters/Parameters.ipynb).\n", + " - `Parameter` : Represents a single value at a given time (e.g. voltage, current), please refer to the [example parameter notebook](../Parameters/Parameters.ipynb).\n", " \n", - " - `ParameterWithSetpoints`: Represents an array of values of all the same type that are returned all at once (e.g. a voltage vs. time waveform). This class is detailed in our [parameter with setpoint notebook](Parameters/Simple-Example-of-ParameterWithSetpoints.ipynb) along with experimental use cases.\n", + " - `ParameterWithSetpoints`: Represents an array of values of all the same type that are returned all at once (e.g. a voltage vs. time waveform). This class is detailed in our [parameter with setpoint notebook](../Parameters/Simple-Example-of-ParameterWithSetpoints.ipynb) along with experimental use cases.\n", "\n", - " - `DelegateParameter`: It is intended for proxy-ing other parameters and is detailed in the [parameter API](../api/parameters/index.rst). You can use different label, unit, etc in the delegated parameter as compared to the source parameter.\n", + " - `DelegateParameter`: It is intended for proxy-ing other parameters and is detailed in the [parameter API](../../api/parameters/index.rst). You can use different label, unit, etc in the delegated parameter as compared to the source parameter.\n", "\n", - "These built in parameter classes are typically used as a wrapper for instrument communications. The user-facing `set` and `get` methods calling instrument facing `set_raw` and `get_raw` methods. Further examples of these parameters are discussed in our example [notebook on Parameters](index.rst#parameters)." + "These built in parameter classes are typically used as a wrapper for instrument communications. The user-facing `set` and `get` methods calling instrument facing `set_raw` and `get_raw` methods. Further examples of these parameters are discussed in our example [notebook on Parameters](../Parameters/index.rst)." ] }, { @@ -491,7 +491,7 @@ "\n", "To conduct a simple measurement, we can create a simple loop inside the context manager which will control the instruments, acquire data, and store the results. \n", "\n", - "> This is the a more user-configurable approach for acquiring data in QCoDeS. For more examples and details, refer to [Performing measurements using QCoDeS parameters and DataSet example](./DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb)\n" + "> This is the a more user-configurable approach for acquiring data in QCoDeS. For more examples and details, refer to [Performing measurements using QCoDeS parameters and DataSet example](../DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb)\n" ] }, { @@ -535,7 +535,7 @@ "source": [ "## Using the doNd multi-dimensional measurement utility \n", "\n", - "Qcodes also includes functions to produce multidimensional data sets with [optimized data handling](DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb); of these, ``dond`` (i.e. do n-dimensional facilitates collecting multidimensional data. Similar optimizations can be made using the measurement context (see [measuring with shaped data](DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb#Specifying-shape-of-measurement)), but this approach simplifies the setup and readability of the code. \n", + "Qcodes also includes functions to produce multidimensional data sets with [optimized data handling](../DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb); of these, ``dond`` (i.e. do n-dimensional facilitates collecting multidimensional data. Similar optimizations can be made using the measurement context (see [measuring with shaped data](../DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb#Specifying-shape-of-measurement)), but this approach simplifies the setup and readability of the code. \n", "\n", "> This is a more user-friendly way of acquiring multi-dimensional data in QCoDeS.\n", "\n", @@ -558,7 +558,7 @@ "metadata": {}, "source": [ "\n", - "This linear sweeps for `dac.ch1` and `dac.ch2` are defined by the endpoints of the sweep (-1 to 1 V), the number of steps (20) and a time delay between each step (0.01 s). This delay time is used to allow real instruments to equilibrate between each step in the sweep. Multiple types of sweeps are [included with QCoDeS](DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb) to enable a variety of sampling schemes. \n", + "This linear sweeps for `dac.ch1` and `dac.ch2` are defined by the endpoints of the sweep (-1 to 1 V), the number of steps (20) and a time delay between each step (0.01 s). This delay time is used to allow real instruments to equilibrate between each step in the sweep. Multiple types of sweeps are [included with QCoDeS](../DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb) to enable a variety of sampling schemes. \n", "\n", "> When using `dond` we do not register parameters, this is done automatically by the function. With dond every dependent parameter depends on all sweep parameters." ] @@ -623,7 +623,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The ``dond`` function features a number of options (e.g. plotting, database write period, multithreading) which are further detailed in our [example notebooks](DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#Handling-plot,-experiment,-and-measurement_name-with-doNd). For simple measurements, [do1d](DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#do1d) and [do2d](DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#do2d) provide a simpler interface with similar functionality for 1d and 2d acquisitions." + "The ``dond`` function features a number of options (e.g. plotting, database write period, multithreading) which are further detailed in our [example notebooks](../DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#Handling-plot,-experiment,-and-measurement_name-with-doNd). For simple measurements, [do1d](../DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#do1d) and [do2d](../DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.ipynb#do2d) provide a simpler interface with similar functionality for 1d and 2d acquisitions." ] }, { @@ -632,7 +632,7 @@ "source": [ "## Exploring datasets and databases\n", "\n", - "In this section we detail methods and functions for working with `DataSets`. In QCoDeS, all measured results are generally packaged and stored in the database as a `DataSet` object. While it isn't essential for running QCoDeS, we provide a [detailed walktrough notebook](DataSet/DataSet-class-walkthrough.ipynb) to assist users in developing new data analysis methods." + "In this section we detail methods and functions for working with `DataSets`. In QCoDeS, all measured results are generally packaged and stored in the database as a `DataSet` object. While it isn't essential for running QCoDeS, we provide a [detailed walktrough notebook](../DataSet/DataSet-class-walkthrough.ipynb) to assist users in developing new data analysis methods." ] }, { @@ -749,7 +749,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "While the arguments are optional, the function call will raise an error if more than one run matching the supplied specifications is found. If such an error occurs, the traceback will contain the specifications of the runs, as well. More examples of refined search criteria for data extraction are provided in [this example notebook](DataSet/Extracting-runs-from-one-DB-file-to-another.ipynb#Uniquely-identifying-and-loading-runs).\n" + "While the arguments are optional, the function call will raise an error if more than one run matching the supplied specifications is found. If such an error occurs, the traceback will contain the specifications of the runs, as well. More examples of refined search criteria for data extraction are provided in [this example notebook](../DataSet/Extracting-runs-from-one-DB-file-to-another.ipynb#Uniquely-identifying-and-loading-runs).\n" ] }, { @@ -852,9 +852,9 @@ "\n", ">For more detailed examples of plotting QCoDeS datasets, we have articles covering a variety of data types:\n", ">\n", - "> - [Offline plotting tutorial](DataSet/Offline%20Plotting%20Tutorial.ipynb)\n", - "> - [Offline plotting with categorical data](DataSet/Offline%20plotting%20with%20categorical%20data.ipynb)\n", - "> - [Offline plotting with complex data](DataSet/Offline%20plotting%20with%20complex%20data.ipynb)" + "> - [Offline plotting tutorial](../DataSet/Offline%20Plotting%20Tutorial.ipynb)\n", + "> - [Offline plotting with categorical data](../DataSet/Offline%20plotting%20with%20categorical%20data.ipynb)\n", + "> - [Offline plotting with complex data](../DataSet/Offline%20plotting%20with%20complex%20data.ipynb)" ] }, { @@ -863,7 +863,7 @@ "source": [ "### QCoDeS measurements live plotting with Plottr\n", "\n", - "Plottr supports and is recommended for live plotting QCoDeS measurements. This enables a direct visualization of an ongoing measurement to facilitate experimentalists. [How to use plottr with QCoDeS for live plotting](plotting/How-to-use-Plottr-with-QCoDeS-for-live-plotting.ipynb) notebook contains more information." + "Plottr supports and is recommended for live plotting QCoDeS measurements. This enables a direct visualization of an ongoing measurement to facilitate experimentalists. [How to use plottr with QCoDeS for live plotting](../plotting/How-to-use-Plottr-with-QCoDeS-for-live-plotting.ipynb) notebook contains more information." ] }, { @@ -951,7 +951,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "We refer reader to [exporting data section of the performing measurements using QCoDeS parameters and dataset](DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb#Accessing-and-exporting-the-measured-data) and [Accessing data in DataSet notebook](DataSet/Accessing-data-in-DataSet.ipynb) for further information on `get_parameter_data` method." + "We refer reader to [exporting data section of the performing measurements using QCoDeS parameters and dataset](../DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.ipynb#Accessing-and-exporting-the-measured-data) and [Accessing data in DataSet notebook](../DataSet/Accessing-data-in-DataSet.ipynb) for further information on `get_parameter_data` method." ] }, { @@ -1489,7 +1489,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "We refer to [example notebook on working with pandas](DataSet/Working-With-Pandas-and-XArray.ipynb) and [Accessing data in DataSet notebook](DataSet/Accessing-data-in-DataSet.ipynb) for further information." + "We refer to [example notebook on working with pandas](../DataSet/Working-With-Pandas-and-XArray.ipynb) and [Accessing data in DataSet notebook](../DataSet/Accessing-data-in-DataSet.ipynb) for further information." ] }, { @@ -1541,7 +1541,7 @@ "source": [ "Here's a short video that summarizes the looks and the features:\n", "\n", - "![video demo about experiments widget should show here](../_static/experiments_widget.webp)" + "![video demo about experiments widget should show here](../../_static/experiments_widget.webp)" ] }, { @@ -1565,7 +1565,7 @@ "metadata": {}, "source": [ "### QCoDeS instrument drivers\n", - "We support and provide drivers for most of the instruments currently in use at the Microsoft stations. However, if more functionalities than the ones which are currently supported by drivers are required, one may update the driver or request the features form QCoDeS team. You are more than welcome to contribute and if you would like to have a quick overview on how to write instrument drivers, please refer to the [this notebook](writing_drivers/Instruments.ipynb) as well as the other [example notebooks on writing drivers](index.rst#writing-drivers)." + "We support and provide drivers for most of the instruments currently in use at the Microsoft stations. However, if more functionalities than the ones which are currently supported by drivers are required, one may update the driver or request the features form QCoDeS team. You are more than welcome to contribute and if you would like to have a quick overview on how to write instrument drivers, please refer to the [this notebook](../writing_drivers/Instruments.ipynb) as well as the other [example notebooks on writing drivers](../writing_drivers/index.rst)." ] }, { @@ -1574,7 +1574,7 @@ "source": [ "### QCoDeS logging\n", "\n", - "In every measurement session, it is highly recommended to have QCoDeS logging turned on. This will allow you to have all the logs in case troubleshooting is required. This feature is detailed further in an [example notebook](logging/logging_example.ipynb) that describes all the logging features." + "In every measurement session, it is highly recommended to have QCoDeS logging turned on. This will allow you to have all the logs in case troubleshooting is required. This feature is detailed further in an [example notebook](../logging/logging_example.ipynb) that describes all the logging features." ] }, { diff --git a/docs/examples/Configuring_QCoDeS.ipynb b/docs/examples/basic_examples/Configuring_QCoDeS.ipynb similarity index 99% rename from docs/examples/Configuring_QCoDeS.ipynb rename to docs/examples/basic_examples/Configuring_QCoDeS.ipynb index b8389d63f92..5d377a62a62 100644 --- a/docs/examples/Configuring_QCoDeS.ipynb +++ b/docs/examples/basic_examples/Configuring_QCoDeS.ipynb @@ -204,7 +204,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The default configuration is explained in more detail in the [api docs](../api/configuration/index.rst#qcodes-default-configuration)" + "The default configuration is explained in more detail in the [api docs](../../api/configuration/index.rst#qcodes-default-configuration)" ] }, { diff --git a/docs/examples/Station.ipynb b/docs/examples/basic_examples/Station.ipynb similarity index 99% rename from docs/examples/Station.ipynb rename to docs/examples/basic_examples/Station.ipynb index 3112671de80..a8c3e8e44f1 100644 --- a/docs/examples/Station.ipynb +++ b/docs/examples/basic_examples/Station.ipynb @@ -293,7 +293,7 @@ "\n", "For example, the `Measurement` object accepts a station argument exactly for the purpose of storing a snapshot of the whole experimental setup next to the measured data.\n", "\n", - "Read more about snapshots in general, how to work with them, station's snapshot in particular, and more -- in [this notebook](DataSet/Working with snapshots.ipynb)." + "Read more about snapshots in general, how to work with them, station's snapshot in particular, and more -- in [this notebook](../DataSet/Working with snapshots.ipynb)." ] }, { @@ -600,7 +600,7 @@ "VSCode can be conveniently used to work with station files. The [YAML extension by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml), allows to use JSON schemas to validate and auto-complete YAML files.\n", "\n", "\n", - "![vscode](assets/vscode_integration.gif \"Auto-validation and -completion in VSCode\")\n", + "![vscode](../assets/vscode_integration.gif \"Auto-validation and -completion in VSCode\")\n", "\n", "\n", "**Quick setup steps**\n", diff --git a/docs/examples/basic_examples/index.rst b/docs/examples/basic_examples/index.rst new file mode 100644 index 00000000000..8bfde3399e2 --- /dev/null +++ b/docs/examples/basic_examples/index.rst @@ -0,0 +1,7 @@ +Basic examples +-------------- + +.. toctree:: + :glob: + + * diff --git a/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb b/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb index 8d134482fa2..2904f032d66 100644 --- a/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb +++ b/docs/examples/driver_examples/Qcodes example with Agilent 34400A.ipynb @@ -116,7 +116,7 @@ "id": "charming-chorus", "metadata": {}, "source": [ - "Above initialized instruments can be registered as components to your station by following instructions as mentioned in [15 min of QCoDeS Notebook](../15_minutes_to_QCoDeS.ipynb)" + "Above initialized instruments can be registered as components to your station by following instructions as mentioned in [15 min of QCoDeS Notebook](../basic_examples/15_minutes_to_QCoDeS.ipynb)" ] }, { diff --git a/docs/examples/driver_examples/index.rst b/docs/examples/driver_examples/index.rst new file mode 100644 index 00000000000..11c45400a9f --- /dev/null +++ b/docs/examples/driver_examples/index.rst @@ -0,0 +1,8 @@ +Drivers +------- + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/docs/examples/index.rst b/docs/examples/index.rst index 7d8d3c3ff45..efd358d1fe2 100644 --- a/docs/examples/index.rst +++ b/docs/examples/index.rst @@ -5,61 +5,16 @@ These are all examples based on notebooks that can be found in https://github.com/QCoDeS/Qcodes/tree/main/docs/examples and below. To experiment with the examples you can download them directly from the git repository. -Basic examples --------------- .. toctree:: - :glob: - - * - - -Parameters ---------------- - -.. include:: Parameters/readme.txt - -.. toctree:: - :glob: - - Parameters/* - -DataSet -------- - -.. toctree:: - :glob: - - DataSet/* - DataSet/Real_instruments/* - DataSet/Cache/* - -Plotting --------- - -.. toctree:: - :glob: - - plotting/* - -Drivers -------- - -.. toctree:: - :maxdepth: 1 - :glob: - - driver_examples/* - -Writing Drivers ---------------- - -.. include:: writing_drivers/readme.txt - -.. toctree:: - :glob: + basic_examples/index + Parameters/index + DataSet/index + plotting/index + driver_examples/index + writing_drivers/index + logging/index - writing_drivers/* Logging -------- diff --git a/docs/examples/logging/index.rst b/docs/examples/logging/index.rst new file mode 100644 index 00000000000..c332b81db02 --- /dev/null +++ b/docs/examples/logging/index.rst @@ -0,0 +1,7 @@ +Logging +-------- + +.. toctree:: + :glob: + + * diff --git a/docs/examples/plotting/index.rst b/docs/examples/plotting/index.rst new file mode 100644 index 00000000000..95d5d86407c --- /dev/null +++ b/docs/examples/plotting/index.rst @@ -0,0 +1,7 @@ +Plotting +-------- + +.. toctree:: + :glob: + + * diff --git a/docs/examples/writing_drivers/index.rst b/docs/examples/writing_drivers/index.rst new file mode 100644 index 00000000000..4c9b0e1e1f2 --- /dev/null +++ b/docs/examples/writing_drivers/index.rst @@ -0,0 +1,9 @@ +Writing Drivers +--------------- + +.. include:: readme.txt + +.. toctree:: + :glob: + + * diff --git a/docs/index.rst b/docs/index.rst index 5a3078800ef..046ea2a2490 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,7 +25,7 @@ The goal is a common framework for physics experiments, so: a new experiment is streamlined - physics experiments can take advantage of modern software and best practices -Read `15 minutes to QcoDeS `_ to have quick overview on QCoDeS. +Read `15 minutes to QcoDeS `_ to have quick overview on QCoDeS. Many more elaborate examples can be found in the `example notebooks `__. @@ -37,7 +37,7 @@ Documentation :maxdepth: 2 start/index - examples/15_minutes_to_QCoDeS + examples/basic_examples/15_minutes_to_QCoDeS examples/index community/index dataset/index