@@ -52,9 +52,8 @@ launch uses the new path. A job fails with "Path for
5252<code > not found" if the code you run has no line in this file.
5353
5454You can also set the path in the Machine Registration window, in the
55- ** Applications** box (see below). [ TO CHECK: that a path entered there for
56- ` localhost ` is written to ` ~/.ECCE/CONFIG.localhost ` and is used for the
57- run.]
55+ ** Program** field on the ** Codes** tab (see below). It is saved in
56+ ` ~/.ECCE/CONFIG.<name> ` , the same file as above.
5857
5958### A code that needs environment variables
6059
@@ -89,72 +88,67 @@ define its queues. Open it in any of these ways:
8988- From a terminal, run ` ecce -machine ` . This opens only Machine
9089 Registration, without a session.
9190
92- The list on the left shows the machines you have registered. The machines
93- supplied with ECCE, ` localhost ` and ` dummy ` , are shared by everyone who
94- uses the installation and are not in your list. If you select one of them
95- elsewhere and choose to register it, the form shows its settings; edit them
96- and click ** Add/Change** to save your own copy under the same name. Your
97- copy is used instead of the shared one. ** Delete Machine** removes your
98- copy and brings the shared one back.
91+ The list on the left shows every machine ECCE knows, with a column
92+ ** From** : ` site ` for the machines supplied with the installation
93+ (` localhost ` and ` dummy ` among them) and ` yours ` for the ones you added.
94+ Site machines are shared by everyone who uses the installation. If you
95+ select one and click ** Save** , ECCE stores your own copy under the same
96+ name, and your copy is used instead of the shared one. ** Delete Machine**
97+ removes your copy and brings the shared one back. The window's tabs are
98+ described in [ Register Machines] ( register-machines.md ) .
9999
100100![ Machine Registration] ( img/machine-registration.png )
101101
102- <!-- capture: Machine Registration window with one cluster registered, Applications and Queues boxes visible -->
102+ <!-- capture: Machine Registration window, Machine tab, one cluster registered -->
103103
104104### Register a cluster
105105
1061061 . Open Machine Registration.
107- 2 . Click ** Clear Form** .
108- 3 . In ** Machine:** , enter the fully qualified host name, for example
109- ` login.hpc.example.edu ` .
110- 4 . In ** Name:** , enter a short name for the list, for example ` hpc ` .
111- 5 . Fill in ** Vendor:** , ** Model:** and ** Processor:** as you wish.
112- [ TO CHECK: whether these three fields are required.]
113- 6 . Set ** Total # Processors:** and ** # Nodes** .
114- 7 . Tick ** ssh** .
115- 8 . In the ** Applications** box, enter the full path to each code on that
116- machine, for example ` NWChem: ` ` /opt/nwchem/bin/nwchem ` . Leave the codes
117- you do not use empty.
118- 9 . In the ** Misc. Paths** box, enter the path to Perl in ** Perl 5:** if it
119- is not the default.
120- 10 . Define the queues (next section).
121- 11 . Click ** Add/Change** .
122- 12 . Click ** Close** .
107+ 2 . Click ** New Machine** .
108+ 3 . On the ** Machine** tab, enter the fully qualified host name in
109+ ** Machine** , for example ` login.hpc.example.edu ` .
110+ 4 . In ** Name** , enter a short name for the list, for example ` hpc ` .
111+ ** Machine** and ** Name** are required; ** Vendor** , ** Model** and
112+ ** Processor** are optional.
113+ 5 . Set ** Processors** and ** Nodes** .
114+ 6 . On the ** Codes** tab, select each code you use and enter the full path
115+ to it on that machine in ** Program** , for example
116+ ` /opt/nwchem/bin/nwchem ` . Leave the codes you do not use empty.
117+ 7 . Define the queues (next section).
118+ 8 . Click ** Save** .
119+ 9 . Click ** Close** .
123120
124121ECCE connects to ssh machines with its own ssh library. It asks for the
125122password, the verification code or an unknown host key in dialogs, so you
126123do not need a terminal. If the machine needs a two-factor login that ECCE
127124cannot answer, use the ` dummy ` machine instead (see below).
128125
129- Code settings that are not paths, such as ` module load ` lines, go in
130- ` ~/.ECCE/CONFIG.<name> ` . ` GETTING_STARTED.md ` describes the file and the
131- variables it can use.
126+ Code settings that are not paths, such as ` module load ` lines, go on the
127+ ** Job script** and ** Codes** tabs; see [ Register
128+ Machines] ( register-machines.md ) . ` GETTING_STARTED.md ` describes the file
129+ and the variables it can use.
132130
133131### Queues
134132
135133A queue is a batch queue on the cluster, with limits ECCE checks before a
136- job is submitted. You define queues in the ** Queues** box of Machine
137- Registration.
134+ job is submitted. You define queues on the ** Queues** tab.
138135
139- 1 . In ** Queue Manager: ** , choose the batch system of the cluster, for
136+ 1 . In ** Queue manager ** , choose the batch system of the cluster, for
140137 example Slurm or PBS. Choose Shell if the machine has none.
141- 2 . Tick ** Allocation Accounts Used ** if the cluster charges jobs to an
138+ 2 . Tick ** Allocation accounts used ** if the cluster charges jobs to an
142139 account.
143- 3 . In ** Queue Name:** , enter the name of the queue.
144- 4 . Set ** Min Processors:** and ** Max Processors:** .
145- 5 . Set ** Max Wall Time:** in minutes (` min ` ). 0 means no limit.
146- 6 . Set ** Max Memory:** in GB. 0 means no limit.
147- 7 . Set ** Min Scratch:** in MB.
148- 8 . Click ** Add/Change Queue** .
149- 9 . Repeat from step 3 for each further queue.
150- 10 . Click ** Add/Change** to save the machine.
151-
152- To change a queue, choose it in ** Queues:** , edit the fields and click
153- ** Add/Change Queue** . ** Remove Queue** deletes the chosen queue and
154- ** Clear All Queues** deletes all of them.
155-
156- [ TO CHECK: whether ** Add/Change Queue** saves on its own or only when
157- ** Add/Change** is clicked for the machine.]
140+ 3 . In ** Name** , enter the name of the queue.
141+ 4 . Set ** min** , ** max** and ** default** for ** Processors** , and ** max**
142+ and ** default** for ** Wall time** (hours), ** Memory** (GB) and
143+ ** Scratch** (GB). 0 means no limit for a ** max** .
144+ 5 . Click ** Add Queue** .
145+ 6 . Repeat from step 3 for each further queue.
146+ 7 . Click ** Save** .
147+
148+ To change a queue, choose it in ** Queues** , edit the fields and click
149+ ** Update Queue** . ** Remove Queue** deletes the chosen queue and ** Remove
150+ All** deletes all of them. Queue changes stay in the list until you click
151+ ** Save** ; nothing is written before that.
158152
159153Your queue definitions are stored in ` ~/.ECCE/Queues ` and in a file per
160154machine, ` ~/.ECCE/<name>.Q ` . They are added to the queues defined for the
@@ -176,8 +170,9 @@ script on your computer and stops.
1761706 . When the job has finished, copy the output file back.
1771717 . In the Organizer, choose ** File > Import Calculation from Output
178172 File...** to bring the results into ECCE (see
179- [ Looking at a file] ( looking-at-a-file.md ) ). [ TO CHECK: the dialog that
180- follows and which calculation the output is attached to.]
173+ [ Looking at a file] ( looking-at-a-file.md ) ). ECCE creates a new
174+ calculation from the output; it is not attached to the calculation you
175+ launched on ` dummy ` .
181176
182177## Job submission settings
183178
0 commit comments