From bd88c9b1480d7ee73a811ea6f8846a71ffae2f1a Mon Sep 17 00:00:00 2001
From: rink <rink@dtu.dk>
Date: Wed, 1 Feb 2017 16:01:57 +0100
Subject: [PATCH] Updating documentation for more Windows info
Specific changes:
- Connecting to the cluster
* split into Windows/Unix subsections
* added much more detail on how to
configure PuTTY
- Mounting cluster discs
* updated Windows text for more details
on how to map network drives
- Preparation
* Changed relative path to wine config
script to an absolute path, since it
wasn't clear where the pbsutils path
was and I didn't know if it was on the
PATH
- TODO (comment in beginning of file)
* Separated into "TODO" and "DONE"
* Moved a few items to "DONE"
---
docs/howto-make-dlcs.md | 102 +++++++++++++++++++++++++++++-----------
1 file changed, 74 insertions(+), 28 deletions(-)
diff --git a/docs/howto-make-dlcs.md b/docs/howto-make-dlcs.md
index 6985059..61085e0 100644
--- a/docs/howto-make-dlcs.md
+++ b/docs/howto-make-dlcs.md
@@ -4,11 +4,14 @@ Auto-generation of Design Load Cases
<!---
TODO, improvements:
-putty reference and instructions (fill in username in the address username@gorm
-how to mount gorm home on windows
do as on Arch Linux wiki: top line is the file name where you need to add stuff
-point to the gorm/jess wiki's
explain the difference in the paths seen from a windows computer and the cluster
+
+DONE:
+- putty reference and instructions (fill in username in the address
+ username@gorm) [rink]
+- how to mount gorm home on windows [rink]
+- point to the gorm/jess wiki's [rink]
-->
> WARNING: these notes contain configuration settings that are specif to the
@@ -69,36 +72,70 @@ and a Python scripting interface:
Connecting to the cluster
-------------------------
-You connect to the cluster via an SSH terminal. SSH is supported out of the box
-for Linux and Mac OSX terminals (such as bash), but requires a separate
-terminal client under Windows. Windows users are advised to use PuTTY and can
-be downloaded at:
-[http://www.chiark.greenend.org.uk/~sgtatham/putty/](http://www.chiark.greenend.org.uk/~sgtatham/putty/).
-Here's a random
-[tutorial](http://www.ghacks.net/2008/02/09/about-putty-and-tutorials-including-a-putty-tutorial/),
-you can use your favourite search engine if you need more or different instructions.
-More answers regarding PuTTY can also be found in the online
+We provide here an overview of how to connect to the cluster, but general,
+up-to-date information can be found in the [HPC documentation](https://docs.hpc.ait.dtu.dk)
+or on the [Gorm-wiki](http://gorm.risoe.dk/gormwiki).
+
+You connect to the cluster via an SSH terminal, and there are different SSH
+terminals based on your operating system (see the platform-specific
+instructions in the next subsections). The cluster can only be reached when
+on the DTU network (wired, or only from a DTU computer when using a wireless
+connection), when connected to the DTU VPN, or from one of the DTU
+[databars](http://www.databar.dtu.dk/).
+
+### Windows
+
+Windows users are advised to use PuTTY, which can
+be downloaded from
+[this link](http://www.chiark.greenend.org.uk/~sgtatham/putty/).
+
+Once you have installed PuTTY and placed the executable somewhere convenient
+(e.g., the Desktop), double click on the executable. In the window that opens
+up, enter/verify the following settings:
+* Session > Host Name: gorm.risoe.dk
+* Session > Port: 22
+* Session > Connection type: SSH
+* Session > Saved Sessions: Gorm
+* Connection > Data > Auto-login username: your DTU username
+* Connection > Data > When username is not specified: Use system username
+* Window > Colours > Select a colour to adjust > ANSI Blue: RGB = 85, 85, 255
+* Window > Colours > Select a colour to adjust > ANSI Bold Blue: RGB = 128, 128, 255
+
+Note that these last two options are optional. We've found that the default
+color for comments, ANSI Blue, is too dark to be seen on the black
+background. The last two options in the list set ANSI Blue and ANSI Blue Bold
+to be lighter and therefore easier to read when working in the terminal. Once
+you have entered these options, click "Save" on the "Session" tab and close
+the window.
+
+With PuTTY configured, you can connect to Gorm by double-clicking the PuTTY
+executable; then, in the window that opens select "Gorm" in "Saved Sessions",
+click the "Load" button, and finally click the "Open" button. A terminal
+window will open up. Type your DTU password in this new window when prompted
+(your text will not appear in the window) and then hit the Enter key. You
+should now be logged into Gorm.
+
+To close the PuTTY window, you can either hit the red "X" in the upper-right
+corner of the window or type "exit" in the terminal and hit enter.
+
+More information on using PuTTY and how it works can be found in this
+[PuTTY tutorial](http://www.ghacks.net/2008/02/09/about-putty-and-tutorials-including-a-putty-tutorial/)
+or in the online
[documentation](http://the.earth.li/~sgtatham/putty/latest/htmldoc/).
+You are also welcome to use Google and read the many online resources.
-The cluster that is setup for using the pre- and post-processing tools for HAWC2
-has the following address: ```gorm.risoe.dk```.
+### Unix
-On Linux/Mac connecting to the cluster is as simple as running the following
-command in the terminal:
+Unlike Windows, SSH is supported out of the box for Linux and Mac OSX
+terminals. To connect to the cluster, enter the following command into
+the terminal:
```
ssh $USER@gorm.risoe.dk
```
-Use your DTU password when asked. This will give you terminal access to the
-cluster called Gorm.
-
-The cluster can only be reached when on the DTU network (wired, or only from a
-DTU computer when using a wireless connection), when connected to the DTU VPN,
-or from one of the DTU [databars](http://www.databar.dtu.dk/).
-
-More information about the cluster can be found on the
-[Gorm-wiki](http://gorm.risoe.dk/gormwiki)
+Enter your DTU password when prompted. This will give you terminal access
+to the Gorm cluster.
Mounting the cluster discs
@@ -110,8 +147,17 @@ will interact regularly with the cluster file system and discs.
### Windows
-It is convenient to map these discs as network drives (in Windows terms).
-Map the following network drives (replace ```$USER``` with your user name):
+It is convenient to map gorm discs to local network drives on Windows, because
+then you can navigate through different directories in Windows Explorer just
+as you would do with normal folders. You can find instructions for mapping network
+drives for your version of Windows by Googling "map network drive $WIN_VERSION",
+where $WIN_VERSION is your version of windows. As an example, in Windows 7, you
+can map a network drive by right-clicking "Computer" in Windows Explorer and then
+selecting "Map network drive". Be sure to check the "Reconnect at sign-in" box if
+you want to connect to this drive every time you log into your computer.
+
+Map the following network drives (replacing ```$USER``` with your user name)
+to any local drive of your choice (e.g., the ```Y:``` or ```Z:``` drives):
```
\\mimer\hawc2sim
@@ -170,7 +216,7 @@ local wine directory, which by default is assumed to be ```~/.wine32```, and
```pbsutils``` contains and automatic configuration script you can run:
```
-g-000 $ config-wine-hawc2.sh
+g-000 $ /home/MET/repositories/toolbox/pbsutils/config-wine-hawc2.sh
```
If you need more information on what is going on, you can read a more detailed
--
GitLab