diff --git a/getting_started/getting-started.md b/getting_started/getting-started.md index f5890212adf9189aa5df865d207651e05c4ac837..5e6544643bada641308e63e72b9a501fbb586f99 100644 --- a/getting_started/getting-started.md +++ b/getting_started/getting-started.md @@ -31,9 +31,9 @@ this writing is shown below.  -These commands follow some conventions, like adding a --help for conveniece. When +These commands follow some conventions, like adding a --help for convenience. When the environment variable DM\_LOGIN\_FILE is defined and points to a file that -contains a username/pasword pair (in the form 'username|password') this information +contains a username/password pair (in the form 'username|password') this information is used for authentication when executing the commands. In practice the account defined here should have the role of station manager for the beamline. @@ -42,7 +42,7 @@ defined here should have the role of station manager for the beamline. #### Getting some data into the system As stated early, the experiment is the central object for creating entries in -the Data Management System. For conveniece there are two commands which can +the Data Management System. For convenience there are two commands which can provide examples of creating experiments, assigning users & other attributes and loading data into the system. These commands are @@ -89,7 +89,7 @@ would use a command like > dm-8idi-upload --experiment=dufresne201707 > --data-directory=/net/s8iddata/export/8-id-i/2017-2/dufresne201707 -> --dest-directory=2017-2 +> --storage-directory=2017-2 Sectors 33 & 34 use a file structure under ROOT\_DIR/username/YYYYMMDD/EXP_NAME/. Here @@ -103,7 +103,7 @@ Here > dm-33bm-upload --experiment=FeCrbilayers > --data-directory=/net/s33data/export/33bm/data/jenia/20140820/FeCrbilayers -> --dest-directory=jenia/20140820 +> --storage-directory=jenia/20140820 #### Creating experiments based on the ESAF/Proposal @@ -117,7 +117,7 @@ are defined in the esaf or proposal to the created experiment. Other DM commands show useful information, and can adjust what and how the information is displayed. `dm-list-experiments` lists the experiments showing -info on the experiemnt name, experiment type, station, and start date. adding the +info on the experiment name, experiment type, station, and start date. adding the option --display-keys can allow the user to display more or less information. --display-keys=name will display only the experiment name, and --display-keys=ALL will display all keys associated with the experiment (one experiment line is show @@ -211,15 +211,15 @@ below. Files transferred onto the storage location will go into: *STORAGE_LOCATION/(storage_root_path)/(experiment_name)*. Files to go into this directory are specified in the entry "Data Directory or Single File Path". Note that if the data directory is specified, only the files will go into the -storage location, not a new subdirectory with the transferred files. Any -subdirectories will be copied as will the contents. +storage location, not a new sub-directory with the transferred files. Any +sub-directories will be copied as will the contents. Once the the storage location and source are defined the transfer can be started in one of two ways: -- A monitor can be placed on the directory and any new files/subdirectories in the directory will be transferred if you select `Start DAQ` -- A one time copy will happen and all files/subdirectories currently in the directry will be copied if you select `Start Upload` +- A monitor can be placed on the directory and any new files/sub-directories in the directory will be transferred if you select `Start DAQ` +- A one time copy will happen and all files/sub-directories currently in the directory will be copied if you select `Start Upload` -When a tranfer is started, the display will switch to either the `DAQs` or +When a transfer is started, the display will switch to either the `DAQs` or `Uploads` tab. The tab will show the status of all transfers that have been started since the last restart of the system. Status of a particular transfer is shown by color @@ -239,7 +239,7 @@ view to show detail of that transfer including errors. #### Workflows and processing data The tab 'Workflows' allows defining a workflows which will provide a template for processing data. A workflow is simply a set of defined steps that will process data. Workflows each step in the workflow executes a command on the host computer. Commands can * be as simple as a single command such as listing a directory - * can tranfer files between computers + * can transfer files between computers * can launch & monitor jobs on a remote cluster * can do just about anything that can be scripted on a computer. Workflow steps allow defining inputs that are defined at runtime and can also create outputs that can be used in following steps.