docs: update to new M-Labs repos URLs

2026-01-21 15:06:55 +08:00
parent 83943a5378
commit 739b0660fe
17 changed files with 26 additions and 26 deletions
@@ -104,7 +104,7 @@ Nix development environment

    - If using NixOS, make the equivalent changes to your ``configuration.nix`` instead.

-* Clone `the ARTIQ Git repository <https://github.com/m-labs/artiq>`_, or `the ARTIQ-Zynq repository <https://git.m-labs.hk/M-Labs/artiq-zynq>`__ for :ref:`Zynq devices <devices-table>` (Kasli-SoC, ZC706, or EBAZ4205). By default, you are working with the ``master`` branch, which represents the beta version and is not stable (see :doc:`releases`). Checkout the most recent release (``git checkout release-[number]``) for a stable version.
+* Clone `the ARTIQ Git repository <https://git.m-labs.hk/M-Labs/artiq>`_, or `the ARTIQ-Zynq repository <https://git.m-labs.hk/M-Labs/artiq-zynq>`__ for :ref:`Zynq devices <devices-table>` (Kasli-SoC, ZC706, or EBAZ4205). By default, you are working with the ``master`` branch, which represents the beta version and is not stable (see :doc:`releases`). Checkout the most recent release (``git checkout release-[number]``) for a stable version.
 * If your Vivado installation is not in its default location ``/opt``, open ``flake.nix`` and edit it accordingly (note that the edits must be made in the main ARTIQ flake, even if you are working with Zynq, see also tip below).
 * Run ``nix develop`` at the root of the repository, where ``flake.nix`` is.

@@ -127,7 +127,7 @@ Building only standard binaries

 If you are working with original ARTIQ, and you only want to build a set of standard binaries (i.e. without changing the source code), you can also enter the *boards* shell without cloning the repository, using ``nix develop`` as follows: ::

-    $ nix develop git+https://github.com/m-labs/artiq.git\?ref=release-[number]#boards
+    $ nix develop git+https://git.m-labs.hk/M-Labs/artiq.git\?ref=release-[number]#boards

 Leave off ``\?ref=release-[number]`` to prefer the current beta version instead of a numbered release.

@@ -136,7 +136,7 @@ Leave off ``\?ref=release-[number]`` to prefer the current beta version instead

 The parallel command does exist for ARTIQ-Zynq: ::

-    $ nix develop git+https://git.m-labs.hk/m-labs/artiq-zynq\?ref=release-[number]
+    $ nix develop git+https://git.m-labs.hk/M-Labs/artiq-zynq\?ref=release-[number]

 but if you are building ARTIQ-Zynq without intention to change the source, it is not actually necessary to enter the development environment at all; Nix is capable of accessing the official flake directly to set up a build, eliminating the requirement for any particular environment. For original ARTIQ, the development environment (specifically the ``#boards`` shell) is still the easiest way to access the necessary tools for flashing a board.

@@ -29,7 +29,7 @@ The ARTIQ compiler recognizes several specialized decorators, which determine th
 ``@host_only`` (:meth:`~artiq.language.core.host_only`) functions are executed fully on the host, similarly to ``@rpc``, but calling them from a kernel as an RPC will be refused by the compiler. It can be used to mark functions which should only ever be called by the host.

 .. warning::
-    ARTIQ goes to some lengths to cache code used in experiments correctly, so that experiments run according to the state of the code when they were started, even if the source is changed during the run time. Python itself annoyingly fails to implement this (see also `issue #416 <https://github.com/m-labs/artiq/issues/416>`_), necessitating a workaround on ARTIQ's part. One particular downstream limitation is that the ARTIQ compiler is unable to recognize decorators with path prefixes, i.e.: ::
+    ARTIQ goes to some lengths to cache code used in experiments correctly, so that experiments run according to the state of the code when they were started, even if the source is changed during the run time. Python itself annoyingly fails to implement this (see also `issue #401 <https://git.m-labs.hk/M-Labs/artiq/issues/401>`_), necessitating a workaround on ARTIQ's part. One particular downstream limitation is that the ARTIQ compiler is unable to recognize decorators with path prefixes, i.e.: ::

         import artiq.experiment as aq

@@ -21,7 +21,7 @@ import sphinx_rtd_theme


 # Ensure that ARTIQ-Python types are correctly printed
-# See: https://github.com/m-labs/artiq/issues/741
+# See: https://git.m-labs.hk/M-Labs/artiq/issues/710
 import builtins
 builtins.__in_sphinx__ = True

@@ -1,7 +1,7 @@
 Developing a Network Device Support Package (NDSP)
 ==================================================

-Besides the kind of specialized real-time hardware most of ARTIQ is concerned with the control and management of, ARTIQ also easily handles more conventional 'slow' devices. This is done through *controllers*, based on `SiPyCo <https://github.com/m-labs/sipyco>`_ (manual hosted `here <https://m-labs.hk/artiq/sipyco-manual/>`_), which expose remote procedure call (RPC) interfaces to the network. This allows experiments to issue RPCs to the controllers as necessary, without needing to do direct I/O to the devices. Some advantages of this architecture include:
+Besides the kind of specialized real-time hardware most of ARTIQ is concerned with the control and management of, ARTIQ also easily handles more conventional 'slow' devices. This is done through *controllers*, based on `SiPyCo <https://git.m-labs.hk/M-Labs/sipyco>`_ (manual hosted `here <https://m-labs.hk/artiq/sipyco-manual/>`_), which expose remote procedure call (RPC) interfaces to the network. This allows experiments to issue RPCs to the controllers as necessary, without needing to do direct I/O to the devices. Some advantages of this architecture include:

 * Controllers/drivers can be run on different machines, alleviating cabling issues and OS compatibility problems.
 * Reduces the impact of driver crashes.
@@ -404,4 +404,4 @@ Merging support

 Being an open-source project, ARTIQ welcomes contributions from outside sources. If you have successfully integrated additional gateware or new hardware into ARTIQ, and you think this might be useful to other ARTIQ users in the community, you might consider merging support -- having your additions incorporated into the canonical ARTIQ codebase. See `this pull request <https://github.com/m-labs/artiq/pull/1800>`_ for one example of such a community addition.

-Merging support also means the opportunity to have your code reviewed by experts, and if your addition is accepted, that maintaining these additions and keeping them up-to-date through new ARTIQ versions may be handled by the developers of ARTIQ directly, instead of being solely your responsibility. Clean up your code, test it well, be sure that it plays well with existing ARTIQ features and interfaces, and follow the `contribution guidelines <https://github.com/m-labs/artiq/blob/master/CONTRIBUTING.rst#contributing-code>`_. Your effort is appreciated!
+Merging support also means the opportunity to have your code reviewed by experts, and if your addition is accepted, that maintaining these additions and keeping them up-to-date through new ARTIQ versions may be handled by the developers of ARTIQ directly, instead of being solely your responsibility. Clean up your code, test it well, be sure that it plays well with existing ARTIQ features and interfaces, and follow the `contribution guidelines <https://git.m-labs.hk/M-Labs/artiq/src/branch/master/CONTRIBUTING.rst>`_. Your effort is appreciated!
@@ -21,11 +21,11 @@ build this documentation?

 To generate this manual from source, you can use ``nix build`` directives, for example: ::

-    $ nix build git+https://github.com/m-labs/artiq.git\?ref=release-[number]#artiq-manual-html
+    $ nix build git+https://git.m-labs.hk/M-Labs/artiq.git\?ref=release-[number]#artiq-manual-html

 Substitute ``artiq-manual-pdf`` to get the LaTeX PDF version. The results will be in ``result``.

-The manual is written in `reStructured Text <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_; you can find the source files in the ARTIQ repository under ``doc/manual``. If you spot a mistake, a typo, or something that's out of date or missing -- in particular, if you want to add something to this FAQ -- feel free to clone the repository, edit the source RST files, and make a pull request with your version of an improvement. (If you're not a fan of or not familiar with command-line Git, both GitHub and Gitea support making edits and pull requests directly in the web interface; tutorial materials are easy to find online.) The second best thing is to open an issue to make M-Labs aware of the problem.
+The manual is written in `reStructured Text <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_; you can find the source files in the ARTIQ repository under ``doc/manual``. If you spot a mistake, a typo, or something that's out of date or missing -- in particular, if you want to add something to this FAQ -- feel free to clone the repository, edit the source RST files, and make a pull request with your version of an improvement. (If you're not a fan of or not familiar with command-line Git, Gitea supports making edits and pull requests directly in the web interface; tutorial materials are easy to find online.) The second best thing is to open an issue to make M-Labs aware of the problem.

 roll back to older versions of ARTIQ, or obtain it through other installation methods?
 --------------------------------------------------------------------------------------
@@ -336,11 +336,11 @@ For more advanced questions, sometimes the `list of publications <https://m-labs
    - How your problem happened, and what you've already tried to fix it

 - Compare your materials with the examples; see also :ref:`finding ARTIQ examples <faq-find-examples>` above.
- Check the list of `active issues <https://github.com/m-labs/artiq/issues>`_ on the ARTIQ GitHub repository for possible known problems with ARTIQ. Search through the closed issues to see if your question or concern has been addressed before.
+- Check the list of `active issues <https://git.m-labs.hk/M-Labs/artiq/issues>`_ on the ARTIQ Gitea repository for possible known problems with ARTIQ. Search through the closed issues to see if your question or concern has been addressed before.
 - Search the `M-Labs forum <https://forum.m-labs.hk/>`_ for similar problems, or make a post asking for help yourself.
 - Look into the `Mattermost live chat <https://chat.m-labs.hk>`_ or the bridged IRC channel.
 - Read the open source code and its docstrings and figure it out.
- If you're reasonably certain you've identified a bug, or if you'd like to suggest a feature that should be included in future ARTIQ releases, `file a GitHub issue <https://github.com/m-labs/artiq/issues/new/choose>`_ yourself, following one of the provided templates.
+- If you're reasonably certain you've identified a bug, or if you'd like to suggest a feature that should be included in future ARTIQ releases, `file a Gitea issue <https://git.m-labs.hk/M-Labs/artiq/issues/new>`_ yourself, following one of the provided templates.
 - In some odd cases, you may want to see the `mailing list archive <https://www.mail-archive.com/artiq@lists.m-labs.hk/>`_; the ARTIQ mailing list was shut down at the end of 2020 and was last regularly used during the time of ARTIQ-2 and 3, but for some older ARTIQ features, or to understand a development thought process, you may still find relevant information there.

 In any situation, if you found the manual unclear or unhelpful, you might consider following the :ref:`directions for contribution <build-documentation>` and editing it to be more helpful for future readers.
@@ -35,7 +35,7 @@ Note that this is **not** ``pkgs.openocd``; the latter is OpenOCD from the Nix p

  The board development shell is an alternative, non-minimal ARTIQ environment which includes additional tools for working with ARTIQ, including OpenOCD. You can enter it with: ::

-  $ nix develop git+https://github.com/m-labs/artiq#boards
+  $ nix develop git+https://git.m-labs.hk/M-Labs/artiq#boards

  However, unless you want more of these additional tools, it's usually preferable to use a lighter custom flake, such as the example in :doc:`installing`.

@@ -302,7 +302,7 @@ Note that the client key and certificate *must* match the client certificate giv

    To connect with multiple clients and/or controller managers or other SSL capable applications, 
    you may concatenate their certificate files into a single ``.pem`` file and use that for all connections. 
-    See `Sipyco SSL document <https://github.com/m-labs/sipyco/blob/master/doc/index.rst#ssl-setup>`_.
+    See `Sipyco SSL document <https://m-labs.hk/artiq/sipyco-manual/#ssl-setup>`_.

 .. .. note--

@@ -20,7 +20,7 @@ User environment installation

 There are few options for accessing ARTIQ through Nix. The easiest way is to install it into the user environment: ::

-  $ nix profile install git+https://github.com/m-labs/artiq.git
+  $ nix profile install git+https://git.m-labs.hk/M-Labs/artiq.git

 Answer "Yes" to the questions about setting Nix configuration options (for more details see :ref:`installing-details` below.) You should now have a minimal installation of ARTIQ, where the usual front-end commands (:mod:`~artiq.frontend.artiq_run`, :mod:`~artiq.frontend.artiq_master`, :mod:`~artiq.frontend.artiq_dashboard`, etc.) are all available to you.

@@ -108,7 +108,7 @@ To find more packages you can browse the `Nix package search <https://search.nix

    $ nix profile list

-  finding the entry with its ``Original flake URL`` listed as the GitHub ARTIQ repository, copying its name, and running: ::
+  finding the entry with its ``Original flake URL`` listed as the Gitea ARTIQ repository, copying its name, and running: ::

    $ nix profile remove [name]

@@ -2,8 +2,8 @@ Introduction
 ------------

 .. this does not work because of relative paths for the logo:
-   .. include:: ../../README.rst
-   and including in README.rst does not work on github therefore just keep this content synchronized with README.rst
+   .. include:: ../../README.md
+   and including in README.md does not work on gitea therefore just keep this content synchronized with README.md

 ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is a leading-edge control and data acquisition system for quantum information experiments.
 It is maintained and developed by `M-Labs <https://m-labs.hk>`_ and the initial development was for and in partnership with the `Ion Storage Group at NIST <https://www.nist.gov/pml/time-and-frequency-division/ion-storage>`_. ARTIQ is free software and offered to the entire research community as a solution equally applicable to other challenging control tasks, including outside the field of ion trapping. Many laboratories around the world have adopted ARTIQ as their control system and some have `contributed <https://m-labs.hk/artiq/funding/>`_ to it.
@@ -12,11 +12,11 @@ The system features a high-level programming language, capable of describing com

 ARTIQ uses FPGA hardware to perform its time-critical tasks. The `Sinara hardware <https://github.com/sinara-hw>`_, and in particular the Kasli FPGA carrier, are designed to work with ARTIQ. ARTIQ is designed to be portable to hardware platforms from different vendors and FPGA manufacturers. Several different configurations of a `FPGA evaluation kit <https://www.xilinx.com/products/boards-and-kits/ek-k7-kc705-g.html>`_ and a `Zynq evaluation kit <https://www.xilinx.com/products/boards-and-kits/ek-z7-zc706-g.html>`_ are also used and supported. FPGA platforms can be combined with any number of additional peripherals, either already accessible from ARTIQ or made accessible with little effort.

-ARTIQ and its dependencies are available in the form of Nix packages (for Linux) and MSYS2 packages (for Windows). See `the manual <https://m-labs.hk/artiq/resources/>`_ for installation instructions. Packages containing pre-compiled binary images to be loaded onto the hardware platforms are supplied for each configuration. Like any open-source software ARTIQ can equally be built and installed directly from `source <https://github.com/m-labs/artiq>`_.
+ARTIQ and its dependencies are available in the form of Nix packages (for Linux) and MSYS2 packages (for Windows). See `the manual <https://m-labs.hk/artiq/resources/>`_ for installation instructions. Packages containing pre-compiled binary images to be loaded onto the hardware platforms are supplied for each configuration. Like any open-source software ARTIQ can equally be built and installed directly from `source <https://git.m-labs.hk/M-Labs/artiq>`_.

 ARTIQ is supported by M-Labs and developed openly. Components, features, fixes, improvements, and extensions are often `funded <https://m-labs.hk/artiq/funding/>`_ by and developed for the partnering research groups.

-Core technologies employed include `Python <https://www.python.org/>`_, `Migen <https://github.com/m-labs/migen>`_, `Migen-AXI <https://github.com/peteut/migen-axi>`_, `Rust <https://www.rust-lang.org/>`_, `MiSoC <https://github.com/m-labs/misoc>`_/`VexRiscv <https://github.com/SpinalHDL/VexRiscv>`_, `LLVM <https://llvm.org/>`_/`llvmlite <https://github.com/numba/llvmlite>`_, and `Qt6 <https://www.qt.io/>`_.
+Core technologies employed include `Python <https://www.python.org/>`_, `Migen <https://git.m-labs.hk/M-Labs/migen>`_, `Migen-AXI <https://github.com/peteut/migen-axi>`_, `Rust <https://www.rust-lang.org/>`_, `MiSoC <https://git.m-labs.hk/M-Labs/misoc>`_/`VexRiscv <https://github.com/SpinalHDL/VexRiscv>`_, `LLVM <https://llvm.org/>`_/`llvmlite <https://github.com/numba/llvmlite>`_, and `Qt6 <https://www.qt.io/>`_.

 | Website: https://m-labs.hk/artiq
 | (US-hosted mirror: https://m-labs-intl.com/artiq)
@@ -81,7 +81,7 @@ and so on.

 .. automodule:: artiq_comtools.artiq_ctlmgr

-ARTIQ controller manager. Supplied in the separate package ``artiq-comtools``, which is included with a standard ARTIQ installation but can also be `installed standalone <https://github.com/m-labs/artiq-comtools>`_, with the intention of making it easier to run controllers and controller managers on machines where a full ARTIQ installation may not be necessary or convenient.
+ARTIQ controller manager. Supplied in the separate package ``artiq-comtools``, which is included with a standard ARTIQ installation but can also be `installed standalone <https://git.m-labs.hk/M-Labs/artiq-comtools>`_, with the intention of making it easier to run controllers and controller managers on machines where a full ARTIQ installation may not be necessary or convenient.

 .. argparse::
   :ref: artiq_comtools.artiq_ctlmgr.get_argparser
@@ -164,7 +164,7 @@ The ``scheduler`` virtual device also exposes information about an experiment's
 Internal details
 ----------------

-Internally, the ARTIQ management system uses Simple Python Communications, or `SiPyCo <https://github.com/m-labs/sipyco>`_, which was originally written as part of ARTIQ and later split away as a generic communications library. The SiPyCo manual is hosted `here <https://m-labs.hk/artiq/sipyco-manual/>`_. The core of the management system is largely contained within ``artiq.master``, which contains the :class:`~artiq.master.scheduler.Scheduler`, the various environment and filesystem databases, and the worker processes that execute the experiments themselves.
+Internally, the ARTIQ management system uses Simple Python Communications, or `SiPyCo <https://git.m-labs.hk/M-Labs/sipyco>`_, which was originally written as part of ARTIQ and later split away as a generic communications library. The SiPyCo manual is hosted `here <https://m-labs.hk/artiq/sipyco-manual/>`_. The core of the management system is largely contained within ``artiq.master``, which contains the :class:`~artiq.master.scheduler.Scheduler`, the various environment and filesystem databases, and the worker processes that execute the experiments themselves.

 By default, the master communicates with other processes over four network ports, see :doc:`default_network_ports`, for logging, broadcasts, notifications, and control. All four of these can be customized by using the ``--port`` flags, see :ref:`the front-end reference<frontend-artiq-master>`.

@@ -49,7 +49,7 @@ A reboot will be required for changes to take effect. See below to learn more ab

 In order to update to a **new release version of ARTIQ** (or to the beta) system-wide, first change the source used in ``flake.nix``: ::

-    inputs.artiq.url = git+https://github.com/m-labs/artiq.git?ref=release-<number>;
+    inputs.artiq.url = git+https://git.m-labs.hk/M-Labs/artiq.git?ref=release-<number>;

 (Remove ``?ref=release-<number>`` entirely for the beta branch). Then update and rebuild as above. Note however that ``sudo nix flake update`` and a rebuild will be required every time to incorporate new commits, and for easy access to the beta it may be better to use a flake, as described in :doc:`installing`.

@@ -1,7 +1,7 @@
 ARTIQ Releases
 ##############

-ARTIQ follows a rolling release model, with beta, stable, and legacy channels. Different releases are saved as different branches on the M-Labs `ARTIQ repository <https://github.com/m-labs/artiq>`_. The ``master`` branch represents the beta version, where at any time the next stable release of ARTIQ is currently in development. This branch is unstable and does not yet guarantee reliability or consistency, but may also already offer new features and improvements; see the `beta release notes <https://github.com/m-labs/artiq/blob/master/RELEASE_NOTES.rst>`_ for the most up-to-date information. The ``release-[number]`` branches represent stable releases, of which the most recent is considered the current stable version, and the second-most recent the current legacy version.
+ARTIQ follows a rolling release model, with beta, stable, and legacy channels. Different releases are saved as different branches on the M-Labs `ARTIQ repository <https://git.m-labs.hk/M-Labs/artiq>`_. The ``master`` branch represents the beta version, where at any time the next stable release of ARTIQ is currently in development. This branch is unstable and does not yet guarantee reliability or consistency, but may also already offer new features and improvements; see the `beta release notes <https://git.m-labs.hk/M-Labs/artiq/src/branch/master/RELEASE_NOTES.rst>`_ for the most up-to-date information. The ``release-[number]`` branches represent stable releases, of which the most recent is considered the current stable version, and the second-most recent the current legacy version.

 To install the current stable version of ARTIQ, consult the *current* `Installing ARTIQ <https://m-labs.hk/artiq/manual/installing.html>`_ page. To install beta or legacy versions, consult the same page in their respective manuals. Instructions given in pre-legacy versions of the manual may or may not install their corresponding ARTIQ systems, and may or may not currently be supported (e.g. M-Labs does not host older ARTIQ versions for Conda, and Conda support will probably eventually be removed entirely). Regardless, all out-of-date versions remain available as complete source code on the repository.

@@ -339,7 +339,7 @@ Absolute timestamps are also referred to as *RTIO fine timestamps,* because they

 The *coarse timestamp* of an event is its timestamp as according to the lower resolution of the coarse clock.   It is in practice a truncated version of the fine timestamp. In general, ARTIQ offers *precision* on the fine level, but *operates* at the coarse level; this is rarely relevant to the user, but understanding it may clarify the behavior of some RTIO issues (e.g. sequence errors).

-  .. Related: https://github.com/m-labs/artiq/issues/1237
+  .. Related: https://git.m-labs.hk/M-Labs/artiq/issues/1120

 Glossary
 --------
@@ -95,7 +95,7 @@ To handle these "slow" devices, ARTIQ uses *controllers*, intermediate pieces of
 Like clients, controllers do not need to be run on the same machine as the master. Various controllers in a device database may in fact be distributed across multiple machines, in whatever way is most convenient for the devices in question, alleviating cabling issues and OS compatibility problems. Each machine running controllers must run its own controller manager. Communication with the master happens over the network. Use the ``-s`` flag of :mod:`~artiq_comtools.artiq_ctlmgr` to set the IP address or hostname of a master to bind to.

 .. tip::
-    The controller manager is made available through the ``artiq-comtools`` package, maintained separately from the main ARTIQ repository. It is considered a dependency of ARTIQ, and is normally included in any ARTIQ installation, but can also be installed independently. This is especially useful when controllers are widely distributed; instead of installing ARTIQ on every machine that runs controllers, only ``artiq-comtools`` and its much lighter set of dependencies are necessary. See the source repository `here <https://github.com/m-labs/artiq-comtools>`_.
+    The controller manager is made available through the ``artiq-comtools`` package, maintained separately from the main ARTIQ repository. It is considered a dependency of ARTIQ, and is normally included in any ARTIQ installation, but can also be installed independently. This is especially useful when controllers are widely distributed; instead of installing ARTIQ on every machine that runs controllers, only ``artiq-comtools`` and its much lighter set of dependencies are necessary. See the source repository `here <https://git.m-labs.hk/M-Labs/artiq-comtools>`_.

 We have already used the controller manager in the previous part of the tutorial. To run it, the only command necessary is: ::

@@ -247,7 +247,7 @@ class Experiment:

 \begin{frame}
  \begin{center}
-  \url{https://github.com/m-labs/artiq}
+  \url{https://git.m-labs.hk/M-Labs/artiq}
  \end{center}

  \footnotesize