From b948ce96de3246db240fd90047f1902300a39c3c Mon Sep 17 00:00:00 2001 From: Egor Savkin Date: Tue, 19 Mar 2024 15:51:59 +0800 Subject: [PATCH] Add artiq start page Signed-off-by: Egor Savkin --- src/SUMMARY.md | 1 + src/sw_sup/artiq_start.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 src/sw_sup/artiq_start.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e72f123..230f439 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -20,6 +20,7 @@ - [Sinara 8451 Thermostat](./hw/thermostat.md) - [Sinara 2245 LVDS DIO](./hw/lvds_dio.md) - [Software/Support](./sw_sup/software_support.md) + - [Starting with ARTIQ](./sw_sup/artiq_start.md) - [Building legacy firmware](./sw_sup/artiq_legacy.md) - [Networking](./sw_sup/networking.md) - [DRTIO](./sw_sup/drtio.md) diff --git a/src/sw_sup/artiq_start.md b/src/sw_sup/artiq_start.md new file mode 100644 index 0000000..60e26d4 --- /dev/null +++ b/src/sw_sup/artiq_start.md @@ -0,0 +1,38 @@ +# Starting with ARTIQ + +This page describes how to start with ARTIQ system for novice users. + +## Connecting wires + +In most cases the system is shipped with power bricks (PSU), DC splitters and SFPs enough to power and control the whole system. +Connect them in following order: +1. Insert Ethernet SFP into the SFP0 of the master or standalone Kasli/Kasli-SoC (Carrier) +2. Connect these SFPs to the router or PC via Ethernet cable (in some cases, optical cable) +3. Insert optic/direct attach SFPs into the master and satellite Carriers, respective to the numeration, [more info in DRTIO page](drtio.md) +4. Power on PSU or EEM power module, by inserting C14 cable, attach DC splitters if available +5. Some cards may have "External power" setting (check the quotation), in this case, insert DC connector into the port +6. Insert remaining cables into the Carriers (not applicable in case of EEM Power Module). + +## Set the network + +By default standalone/master Carriers arrive with 192.168.1.75/24 set as their static address. Carrier will try to acquire this address +from your router, and in case of failure, they will be just unavailable from the network. Check the following articles for troubleshooting network issues: +* [Networking](networking.md) +* [Official docs](https://m-labs.hk/artiq/manual/installing.html#setting-up-the-core-device-ip-networking) + +## Run first experiment via artiq_run + +Before diving in to the repository experiments management and scheduling, it is essential to try run your first experiment +via most basic way - `artiq_run`. For this you need to enter your ARTIQ environment (console) and run: +```shell +artiq_run --device-db path/to/device_db.py path/to/experiment.py +``` + +In case your directory contains relevant `device_db` file, you may omit the `--device-db path/to/device_db.py` part. +To check this, you may run `ls .` and check if it is in the list. + +On pre-installed NUCs, the ARTIQ commands are available everywhere, and you just need to run them. +If you have Nix package manager or NixOS, you will just need to enter the shell with `nix develop github:m-labs/artiq\?ref=release-7`. +If you have installed ARTIQ with Conda, you will need to activate the environment with `conda activate `. + +You may check for experiments in the [official docs](https://m-labs.hk/artiq/manual/getting_started_core.html). \ No newline at end of file