updated readme
This commit is contained in:
@@ -23,24 +23,23 @@ On some systems, you may need to use `pip3` and `python3` instead.
|
|||||||
|
|
||||||
### Using a remote magma installation
|
### 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
|
If the magma instance is on a remote machine, you can add an ssh key to the remote machine and
|
||||||
the following function in your `.bashrc` or `.zshrc`
|
create a script like the following (e.g., in `~/.local/bin/magma`, ensuring that the directory is in
|
||||||
|
your `PATH`):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
function magma() {
|
#!/bin/sh
|
||||||
ssh -qt user@remote "magma $*"
|
exec ssh -qt user@remote "magma $*"
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, you can use it "locally" with the following command:
|
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.
|
||||||
```sh
|
|
||||||
$ magma
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## 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
|
```sh
|
||||||
# Select "New" -> "Notebook" and then in the new tab select "Magma" as the kernel
|
# Select "New" -> "Notebook" and then in the new tab select "Magma" as the kernel
|
||||||
|
|||||||
Reference in New Issue
Block a user