From a6d3fb46819a87efed12ce561003885ac60353d3 Mon Sep 17 00:00:00 2001 From: "Jens H. Nielsen" Date: Tue, 9 Jan 2024 15:19:20 +0100 Subject: [PATCH] fix links to qcodes docs Reflecting the fact that qocdes has moved to microsoft org --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.rst | 2 +- README.rst | 12 ++++++------ docs/changes/0.20.0.rst | 2 +- docs/community/related_projects.rst | 2 +- .../Exporting-data-to-other-file-formats.ipynb | 4 ++-- docs/examples/DataSet/The-Experiment-Container.ipynb | 2 +- docs/examples/Station.ipynb | 2 +- .../Qcodes example with Rigol DS1074Z.ipynb | 2 +- pyproject.toml | 4 ++-- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ce681ea1668..b79883dae0d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -22,7 +22,7 @@ If this fixes a known bug reported against QCoDeS: - [ ] Please include a string in the following form ``closes #xxx`` where ``xxx``` is the number of the bug fixed. -Please have a look at [the contributing guide](https://qcodes.github.io/Qcodes/community/contributing.html) +Please have a look at [the contributing guide](https://microsoft.github.io/Qcodes/community/contributing.html) for more information. If you are in doubt about any of this please ask and we will be happy to help. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a91f692db30..0bf62a17eda 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -76,7 +76,7 @@ Setup ~~~~~ - Clone and register the package for development as described - `here `__ + `here `__ - Run tests - Ready to hack diff --git a/README.rst b/README.rst index 4fdf2236ea3..40786e8af73 100644 --- a/README.rst +++ b/README.rst @@ -8,10 +8,10 @@ While it has been developed to serve the needs of nanoelectronic device experiments, it is not inherently limited to such experiments, and can be used anywhere a system with many degrees of freedom is controllable by computer. -To learn more about QCoDeS, browse our `homepage `_ . +To learn more about QCoDeS, browse our `homepage `_ . To get a feeling of QCoDeS read -`15 minutes to QCoDeS `__, +`15 minutes to QCoDeS `__, and/or browse the Jupyter notebooks in `docs/examples `__ . @@ -33,14 +33,14 @@ If you are working with a local clone of QCoDeS you should update it as follows: Install ======= -In general, refer to `here `__ +In general, refer to `here `__ for installation. Docs ==== -Read it `here `__ . +Read it `here `__ . Documentation is updated and deployed on every successful build in main. We use sphinx for documentations, makefiles are provided both for @@ -69,7 +69,7 @@ The modules ``qcodes.data``, ``qcodes.plots``, ``qcodes.actions``, and ``qcodes.utils.magic`` that were part of QCoDeS until version 0.37.0. have been moved into an independent package called qcodes_loop. Please see it's `repository `_ and -`documentation `_ for more information. +`documentation `_ for more information. For the time being it is possible to automatically install the qcodes_loop package when installing qcodes by executing ``pip install qcodes[loop]``. @@ -110,6 +110,6 @@ See `License `__. .. |PyPI python versions| image:: https://img.shields.io/pypi/pyversions/qcodes.svg :target: https://pypi.python.org/pypi/qcodes/ .. |DOCS| image:: https://img.shields.io/badge/read%20-thedocs-ff66b4.svg - :target: http://qcodes.github.io/Qcodes + :target: http://microsoft.github.io/Qcodes .. |DOI| image:: https://zenodo.org/badge/37137879.svg :target: https://zenodo.org/badge/latestdoi/37137879 diff --git a/docs/changes/0.20.0.rst b/docs/changes/0.20.0.rst index dccee801a95..9a3f433dfda 100644 --- a/docs/changes/0.20.0.rst +++ b/docs/changes/0.20.0.rst @@ -16,7 +16,7 @@ Breaking Changes: ---- New: ---- -- The ``DataSet`` shape is used when loading data; this impacts the ``DataSet.get_parameter_data`` and ``DataSet.cache.data`` methods. See also `the measurement docs `_ for more info on how data are loaded (:pr:`2264`) +- The ``DataSet`` shape is used when loading data; this impacts the ``DataSet.get_parameter_data`` and ``DataSet.cache.data`` methods. See also `the measurement docs `_ for more info on how data are loaded (:pr:`2264`) - The ``Measurement`` now captures exception info in the ``DataSet`` s metadata if an exception occured during measurement (:pr:`2327`) - There is now an explicit API for marking the ``cache`` of a ``Parameter`` as invalid (:pr:`2012`) - New support email introduced (:pr:`2366`) diff --git a/docs/community/related_projects.rst b/docs/community/related_projects.rst index c7d311a1ab5..f4753e53921 100644 --- a/docs/community/related_projects.rst +++ b/docs/community/related_projects.rst @@ -25,7 +25,7 @@ with ``pip install qcodes_contrib_drivers`` The source code is hosted on Github `here `__ and the documentation can be found -`here `__ +`here `__ Broadbean diff --git a/docs/examples/DataSet/Exporting-data-to-other-file-formats.ipynb b/docs/examples/DataSet/Exporting-data-to-other-file-formats.ipynb index faa43500f1e..5fd156d7089 100644 --- a/docs/examples/DataSet/Exporting-data-to-other-file-formats.ipynb +++ b/docs/examples/DataSet/Exporting-data-to-other-file-formats.ipynb @@ -305,9 +305,9 @@ "metadata": {}, "source": [ "Datasets may also be exported automatically using the configuration options given in dataset config section. \n", - "Here you can toggle if a dataset should be exported automatically using the `export_automatic` option as well as set the default type, prefix, elements in the name, and path. See [the table here](https://qcodes.github.io/Qcodes/api/configuration/index.html#qcodes-default-configuration) for the relevant configuration options.\n", + "Here you can toggle if a dataset should be exported automatically using the `export_automatic` option as well as set the default type, prefix, elements in the name, and path. See [the table here](https://microsoft.github.io/Qcodes/api/configuration/index.html#qcodes-default-configuration) for the relevant configuration options.\n", "\n", - "For more information about how to configure QCoDeS datasets see [the page about configuration](https://qcodes.github.io/Qcodes/api/configuration/index.html) in the QCoDeS docs.\n", + "For more information about how to configure QCoDeS datasets see [the page about configuration](https://microsoft.github.io/Qcodes/api/configuration/index.html) in the QCoDeS docs.\n", "\n", "By default datasets are exported into a folder next to the database with the same name but ``.`` replaced by ``_`` e.g. if you store data to ``~/experiments.db`` the exported files will be storred in ``~/experiments_db``\n", "This folder is automatically created if it does not exist. " diff --git a/docs/examples/DataSet/The-Experiment-Container.ipynb b/docs/examples/DataSet/The-Experiment-Container.ipynb index 4bf0fb66cb1..65fd814e568 100644 --- a/docs/examples/DataSet/The-Experiment-Container.ipynb +++ b/docs/examples/DataSet/The-Experiment-Container.ipynb @@ -105,7 +105,7 @@ "source": [ "Not surprisingly, our new database is empty.\n", "\n", - "We now introduce a term that we call the **default experiment**. In short, it is the experiment that will be used for a QCoDeS `DataSet`, if the user do not explicitly pass an experiment into objects that create that `DataSet`. In another word, that `DataSet` will be belong to the default experiment. We do not want to go into the details of `DataSet` here, and refer to the [DataSet notebook](https://qcodes.github.io/Qcodes/examples/DataSet/DataSet-class-walkthrough.html) and [Performing measurements using qcodes parameters and dataset](https://qcodes.github.io/Qcodes/examples/DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.html) for what we mean from `DataSet` and how we can pass an experiment explicitly.\n", + "We now introduce a term that we call the **default experiment**. In short, it is the experiment that will be used for a QCoDeS `DataSet`, if the user do not explicitly pass an experiment into objects that create that `DataSet`. In another word, that `DataSet` will be belong to the default experiment. We do not want to go into the details of `DataSet` here, and refer to the [DataSet notebook](https://microsoft.github.io/Qcodes/examples/DataSet/DataSet-class-walkthrough.html) and [Performing measurements using qcodes parameters and dataset](https://microsoft.github.io/Qcodes/examples/DataSet/Performing-measurements-using-qcodes-parameters-and-dataset.html) for what we mean from `DataSet` and how we can pass an experiment explicitly.\n", "\n", "By default, the last experiment in the database is the default experiment. The default experiment can be changed if another experiment in the database is created or loaded. We will explore this in this notebook. \n", "\n", diff --git a/docs/examples/Station.ipynb b/docs/examples/Station.ipynb index 7a408a09430..2b987a3b5a4 100644 --- a/docs/examples/Station.ipynb +++ b/docs/examples/Station.ipynb @@ -544,7 +544,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "QCoDeS configuration contains entries that are related to the `Station` and its YAML configuration file. Refer to [the description of the 'station' section in QCoDeS config](http://qcodes.github.io/Qcodes/user/configuration.html?highlight=station#default-config) for more specific information." + "QCoDeS configuration contains entries that are related to the `Station` and its YAML configuration file. Refer to [the description of the 'station' section in QCoDeS config](http://microsoft.github.io/Qcodes/user/configuration.html?highlight=station#default-config) for more specific information." ] }, { diff --git a/docs/examples/driver_examples/Qcodes example with Rigol DS1074Z.ipynb b/docs/examples/driver_examples/Qcodes example with Rigol DS1074Z.ipynb index 725d468e138..f5f891e0add 100644 --- a/docs/examples/driver_examples/Qcodes example with Rigol DS1074Z.ipynb +++ b/docs/examples/driver_examples/Qcodes example with Rigol DS1074Z.ipynb @@ -120,7 +120,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - " This particular driver implements acquiring the trace as a `ParameterWithSetpoints`. Here, we show how the trace can be measured and plotted. For more information on `ParameterWithSetpoints` refer to [this notebook](http://qcodes.github.io/Qcodes/examples/Parameters/Simple-Example-of-ParameterWithSetpoints.html)." + " This particular driver implements acquiring the trace as a `ParameterWithSetpoints`. Here, we show how the trace can be measured and plotted. For more information on `ParameterWithSetpoints` refer to [this notebook](http://microsoft.github.io/Qcodes/examples/Parameters/Simple-Example-of-ParameterWithSetpoints.html)." ] }, { diff --git a/pyproject.toml b/pyproject.toml index 69c32482d89..07f13e2e38c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -67,10 +67,10 @@ content-type = "text/x-rst" [project.urls] Homepage = "https://github.com/QCoDeS/Qcodes" -Documentation = "https://qcodes.github.io/Qcodes/" +Documentation = "https://microsoft.github.io/Qcodes/" Source = "https://github.com/qcodes/qcodes" Tracker = "https://github.com/QCoDeS/Qcodes/issues" -Changelog = "https://qcodes.github.io/Qcodes/changes/index.html" +Changelog = "https://microsoft.github.io/Qcodes/changes/index.html" [project.optional-dependencies] zurichinstruments = ["zhinst-qcodes>=0.3"]