Skip to content

Commit 341be70

Browse files
authored
Update index.rst
1 parent edc098a commit 341be70

1 file changed

Lines changed: 23 additions & 27 deletions

File tree

docs/installation/index.rst

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ After installing, make sure you have the **mamba** command available in your she
2020

2121
.. code-block:: bash
2222
23-
# Create a new environment for simstack client:
23+
# Create a new environment for the simstack client:
2424
mamba create --name=simstack simstack -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
2525
# Activate the environment
2626
conda activate simstack
@@ -50,21 +50,21 @@ The client version requires passwordless via ``ssh`` access to communicate with
5050
``authorized_keys`` file of your user account on the available HPC resource. You achieve this with two simple commands,
5151
as shown below.
5252

53-
.. warning:: Please run the below commands on the same local machine, where the **SimStack** client will be installed.
53+
.. warning:: Please run the below commands on the same local machine where the **SimStack** client will be installed.
5454

5555
Installation on Linux and OSX (Arm and x64)
5656
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5757

5858
If you don't have the ``ssh`` keys, use the steps below to generate them.
5959

60-
* ``ssh`` key generation, just press enter for the passphrase option.
60+
* ``ssh`` key generation, press enter for the passphrase option.
6161

6262
.. code-block:: bash
6363
6464
ssh-keygen -t rsa
6565
66-
* The ssh-key command above generated two keys in the ``~/.ssh`` directory.
67-
Now you have to copy the key to your user account in one of the available HPC resources.
66+
* The ssh-key command generated two keys in the ``~/.ssh`` directory.
67+
Now, you must copy the key to your user account in one of the available HPC resources.
6868

6969
.. code-block:: bash
7070
@@ -83,7 +83,7 @@ If you don't have the ``ssh`` keys, use the steps below to generate them.
8383
8484
ssh <username>@<computer name or IP address>
8585
86-
* After completing, the above steps runs the below commands.
86+
* After completing the above steps, run the below commands.
8787

8888
.. code-block:: bash
8989
@@ -94,17 +94,17 @@ If you don't have the ``ssh`` keys, use the steps below to generate them.
9494
Installation on Windows
9595
^^^^^^^^^^^^^^^^^^^^^^^
9696

97-
You have two options on Windows: You can install either the native Windows version, or (in an updated WSL2 environment) the Linux version.
97+
You have two options on Windows: You can install either the native Windows version or (in an updated WSL2 environment) the Linux version.
9898
WSL2 comes with all client tools required, so this is the recommended approach. If you want to use the Windows version, continue this tutorial.
9999

100100
If you don't have the ``ssh`` keys, use the steps below to generate them.
101101

102-
* Make sure that the `ssh` is enabled on your Windows system.
102+
* Ensure the `ssh` is enabled on your Windows system.
103103

104-
* Check if **Powershell** is installed on your Windows system, if not you can install it from the Microsoft Store.
104+
* Check if **Powershell** is installed on your Windows system. If not, you can install it from the Microsoft Store.
105105

106106
* To generate a public/private ``rsa key pair`` on Windows, open the **Powershell** prompt run the
107-
below command, and just press enter for the passphrase option.
107+
below command, and press enter for the passphrase option.
108108

109109
.. code-block:: bash
110110
@@ -115,11 +115,10 @@ If you don't have the ``ssh`` keys, use the steps below to generate them.
115115

116116
.. code:: bash
117117
118-
type $env:USERPROFILE\.ssh\id_rsa.pub | ssh user@int-nano.int.kit.edu "cat >> .ssh/authorized_keys"
119-
type $env:USERPROFILE\.ssh\id_rsa.pub | ssh user@int.bionano.int.kit.edu "cat >> .ssh/authorized_keys"
118+
type $env:USERPROFILE\.ssh\id_rsa.pub | ssh <username>@<computer name or IP address> "cat >> .ssh/authorized_keys"
120119
121120
122-
* After completing, the above steps, double click on ``run-simstack`` and be happy.
121+
* After completing the above steps, double-click on ``run-simstack`` and be happy.
123122

124123
**Testing the connectivity**
125124

@@ -147,20 +146,20 @@ Simstack Server Configuration
147146

148147
.. figure:: /assets/simstack_configuration.png
149148

150-
You must replace the characters ``xxxxxx`` with your proper setup as highlighted in the figure above,
149+
You must replace the characters ``xxxxxx`` with your proper setup, as highlighted in the figure above,
151150
and don't forget to load (**SSH Private Key**) your ``ssh`` key.
152151

153152
- **Registry Name**: accepts any name.
154153

155-
- **Base URI**: can accepts any HPC IP, but here we will limit ourselves with one of the below options.
154+
- **Base URI**: can accept any HPC IP, but here we will limit ourselves with one of the below options.
156155

157156
- int-bionano.int.kit.edu
158157
- int-nano.int.kit.edu
159158

160-
- **Username**: enter with the user account according to your available HPC resource.
159+
- **Username**: enter the user account according to your available HPC resource.
161160

162161

163-
* If `ssh` key is setup correctly, you should now be able to connect by clicking the `Connect` button at the top right of SimStack.
162+
* If `ssh` key is set up correctly, you should now be able to connect by clicking the `Connect` button at the top right of SimStack.
164163
The green button means you successfully connect to the server.
165164

166165
.. figure:: /assets/simstack_gui.png
@@ -176,14 +175,11 @@ Simstack Overview
176175

177176
Using the **SimStack** client (picture above), simulation workflows are constructed by dragging and
178177
dropping various (already incorporated modules) from the window on the left side area (**Available WaNos**) into
179-
the **Workflow canvas area**. Double click each module to modify module-specific parameters (see **input file** field)
180-
and allocate resources in the **Requested computational resources** field for each module. To save and reuse your workflow
181-
lately, press ``` Crtl+S``` or ```File -> Save```. It will then appear in the left panel **Saved Workflows** and can be
182-
re-loaded by double-clicking. To submit your workflow, connect to the computational resource (the connect button as shown
183-
in the last figure of **Simstack Server Configuration section**) and click ```Run -> Run``` on the menu bar,
178+
the **Workflow canvas area**. Double-click each module to modify module-specific parameters (see **input file** field)
179+
and allocate resources in the **Requested computational resources** field for each module. To save and reuse your workflow, press ``` Crtl+S``` or ```File -> Save```. It will then appear in the left panel **Saved Workflows** and can be
180+
re-loaded by double-clicking. To submit your workflow, connect to the computational resource (the connect button shown
181+
in the last figure of **Simstack Server Configuration section**) and click ```Run -> Run``` on the menu bar
184182
or ```Crtl + r```. All required input files are uploaded automatically to the HPC resource, and workflow modules may
185-
run serially or in parallel, depending on if your workflow uses or not some of the **Loop controls** features. As shown in
186-
the figure above, the **SimStack** client will display a yellow folder while be running. When successfully finished,
187-
the client will exhibit a green folder, and you will be able to retrieve all the relevant data from your simulations. If the
188-
simulation presents a computational issue during the execution, **SimStack** returns a red folder, which we can be
189-
inspected to fix the problem.
183+
run serially or in parallel, depending on whether your workflow uses or not some of the **Loop controls** features. The figure above shows that the **SimStack** client will display a yellow folder while running. When successfully finished,
184+
the client will exhibit a green folder, and you can retrieve all the relevant data from your simulations. If the
185+
simulation presents a computational issue during the execution, **SimStack** returns a red folder, which we can inspect to fix the problem.

0 commit comments

Comments
 (0)