User Tools

Site Tools


exp_create_task

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
exp_create_task [2016/05/18 17:17]
lbeseme
exp_create_task [2017/08/22 14:32] (current)
mimbert migrate from scenario.desc to scenario.yaml
Line 1: Line 1:
 ===== Create an experiment ===== ===== Create an experiment =====
  
-Now that all the experiment material has been successfully uploaded on the airlock you will have to create a task file. The task file is a simple tar.gz archive file that contains your experiment material alongside an experiment description file: `scenario.desc`.+Now that all the experiment material has been successfully uploaded on the airlock you will have to create a task file. The task file is a simple tar.gz archive file that contains your experiment material alongside an experiment description file: `scenario.yaml`.
  
 ==== The experiment description file ==== ==== The experiment description file ====
  
-The experiment description file called `scenario.desc` will be looked for and read by the experiment scheduler to get which nodes and what software will be used during the experiment. It also gives the necessary startup scripts and parameters that the user provides for his experiment.+The experiment description file called `scenario.yaml` will be looked for and read by the experiment scheduler to get which nodes and what software will be used during the experiment. It also gives the necessary startup scripts and parameters that the user provides for his experiment.
  
 Here is a simple example of a `scenario.desc` file: Here is a simple example of a `scenario.desc` file:
Line 16: Line 16:
 # Scenario textual description # Scenario textual description
 #   ​simple string (a one liner) #   ​simple string (a one liner)
-desc OFDM tx-rx example scenario for CorteXlab+description: ​OFDM tx-rx example scenario for CorteXlab
  
 # Experiment maximum duration # Experiment maximum duration
 #   Time after which the experiment is forced to stop #   Time after which the experiment is forced to stop
-#   ​integer (minutes+#   ​integer (seconds
-durat 2+duration: 120
  
 # Node list # Node list
Line 27: Line 27:
 #   ​format:​ #   ​format:​
 # #
-#   ​(machine):​ +#   nodes: 
-  entry (entry point script relative to the task root+#     (machine):​ 
-#   exit (exit point script relative to the task root. Use "​none"​ for none)+      command: ​(entry point script relative to the task root)
  
-node4: +nodes: 
-   entry benchmark_rx.py +  ​node4: 
-   ​params ​--antenna="​TX/​RX"​ --rx-gain=25 -v -W 2M -f 2.49G +    ​command: ​benchmark_rx.py --antenna="​TX/​RX"​ --rx-gain=25 -v -W 2M -f 2.49G 
-   exit none +  node6: 
- +    ​command: ​benchmark_tx.py --antenna="​TX/​RX"​ --tx-amplitude=0.2 -v -W 2M -f 2.49G
-node6: +
-   entry benchmark_tx.py +
-   ​params ​--antenna="​TX/​RX"​ --tx-amplitude=0.2 -v -W 2M -f 2.49G +
-   exit none+
 </​code>​ </​code>​
  
Line 46: Line 42:
 ==== Creating the task file ==== ==== Creating the task file ====
  
-Once the `scenario.desc` file is written, put all the experiment material and the `scenario.desc` file in the same directory. The file tree could look like something like that:+Once the `scenario.yaml` file is written, put all the experiment material and the `scenario.yaml` file in the same directory. The file tree could look like something like that:
 <​code>​ <​code>​
 ... ...
Line 53: Line 49:
 │   ├── benchmark_tx.py │   ├── benchmark_tx.py
 │   ├── receive_path.py │   ├── receive_path.py
-│   ├── scenario.desc+│   ├── scenario.yaml
 │   ├── transmit_path.py │   ├── transmit_path.py
 │   └── uhd_interface.py │   └── uhd_interface.py
exp_create_task.txt · Last modified: 2017/08/22 14:32 by mimbert