From 0fec64572a04781f77d64e1dfff585244cad5d26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pedro=20Agostinho=20de=20Sousa?= Date: Wed, 9 Jul 2025 13:02:28 +0200 Subject: [PATCH] Update README --- README.md | 31 ++++++++----------------------- 1 file changed, 8 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8d9f76f..5e99aaa 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,20 @@ -# CryoSPARC Merlin Scripts +# CryoSPARC Merlin 7 lanes -This repository contains CryoSPARC *lanes* tailored for running jobs at PSI using the Merlin 7 system. +This repository contains CryoSPARC *lanes* tailored for running jobs at PSI using Merlin 7. ## Installation -Clone the repository using Git on **Merlin 7**. This is typically done from within your CryoSPARC installation directory (e.g., `/data/user//cryosparc/`), though this is not strictly required: +Clone the repository using Git on **Merlin 7**. This is typically done from within your CryoSPARC installation directory (e.g., `/data/user//cryosparc/`): ```bash git clone -b merlin7 https://gitea.psi.ch/CLS-IT/merlin-cryosparc.git config ```` +If you already have cloned this repository, run the following command in your directory CryoSPARC installation directory: +```bash +git pull +``` + Next, update all `cluster_info.json` files to reflect the correct worker path by replacing the placeholder `USERNAME`. A helper script is available to do this automatically: ```bash @@ -28,26 +33,6 @@ Alternatively, to connect a specific lane manually: ssh $USER@merlin7-cryosparc01.psi.ch "connect_new lane_name" ``` -## Updating - -To fetch the latest features and bug fixes, update the repository: - -```bash -git pull -``` - -Optionally, you can remove outdated lanes before reconnecting (recommended when updating): - -```bash -ssh $USER@merlin7-cryosparc01.psi.ch "cryosparcm cluster remove 'lane_name'" -``` - -Then reconnect lanes as shown in the installation steps: - -```bash -ssh $USER@merlin7-cryosparc01.psi.ch "connect_all" -``` - ## For Developers If you're contributing to this repository, install Git filters and hooks by running: