From eedcfd9984bc0ea5d13b473217cb1ae17909b5ef Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Sun, 24 Nov 2024 16:40:10 +0100 Subject: [PATCH] updated readme --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2ee4b1f..92f95a7 100644 --- a/README.md +++ b/README.md @@ -23,24 +23,23 @@ On some systems, you may need to use `pip3` and `python3` instead. ### Using a remote magma installation -If the magma instance is on a remote machine, you can add an ssh key to the remote machine and add -the following function in your `.bashrc` or `.zshrc` +If the magma instance is on a remote machine, you can add an ssh key to the remote machine and +create a script like the following (e.g., in `~/.local/bin/magma`, ensuring that the directory is in +your `PATH`): ```sh -function magma() { - ssh -qt user@remote "magma $*" -} +#!/bin/sh +exec ssh -qt user@remote "magma $*" ``` -Then, you can use it "locally" with the following command: - -```sh -$ magma -``` +Then run `chmod +x ~/.local/bin/magma` to make it executable. Now, if you install the kernel as +above you can use it "locally" by running `magma` as if it were installed on your machine. ## Usage -To use the kernel, run one of the following commands +You need the local `magma` executable to be in your `PATH` to use the kernel, you can also use the +remote magma installation as described above. Now to use the kernel, run one of the following +commands ```sh # Select "New" -> "Notebook" and then in the new tab select "Magma" as the kernel