Page History

...

1. Install AVISO following instructions on: https://pyaviso.readthedocs.io/en/latest/guide/getting_started.html#installing 
   
   
2. Create ~/.marsrc/mars.email and ~/.marsrc/mars.token files. mars.email file should contain “email” listed here: https://api.ecmwf.int/v1/key and mars.token file should contain “key” shown on the same page.

3. Create a configuration file in the default location ~/.aviso/config.yaml

   Code Block
   language yml
   username_file: ~/.marsrc/mars.email key_file: ~/.marsrc/mars.token notification_engine: type: etcd_rest host: aviso.ecmwf.int port: 443 https: true configuration_engine: type: etcd_rest host: aviso.ecmwf.int port: 443 https: true schema_parser: ecmwf remote_schema: True auth_type: ecmwf

   
   

   
   
   
4. Create your listener configuration file(s) with following content:
   1. Example for dissemination:
      

      Code Block
      language yml title listener_diss.yaml
      listeners: - event: dissemination request: destination: <user_destination> class: od expver: 1 domain: g stream: enfo step: [1,2,3] triggers: - type: echo

      Note the dissemination event listener. request describes for which dissemination event users want to execute the triggers. It is made of a set of fields. Users have to specify only the fields they wants to use as filters. destination is a mandatory field and it is associated to one or more destinations which are linked to the user's ECMWF account. Only the notifications complying with all the fields defined will execute the trigger. The trigger in this example is echo. This will simply print out the notification to the console output.
      
      
   2. Example for MARS:
      

      Code Block
      language yml title listener_mars.yaml
      listeners: - event: mars request: class: od expver: 1 domain: g stream: enfo step: [1,2,3] triggers: - type: echo

      
      Note, in the MARS event listener, destination field is not present. You can see the the full list of allowed fields for MARS/ dissemination event listeners here.
      
      

      Warning

      Aviso will notify when data exists in MARS, but most users will not be able to retrieve this data before the scheduled time (Dissemination schedule). Triggering an automated retrieval of data will require adding logic to ensure you only retrieve data when you have respective permissions to do so. For automation of downstream time-critical workflows, this should mainly be based on dissemination events.

      
      
      
5. If AVISO is installed in Python virtual environment, activate the environment first:
   

   Code Block
   language bash
   source {PATH_TO_MY_ENV}/myenv/bin/activate

   
   
   
6. Launch the AVISO application to listen ECMWF defined in your configuration file:
   

   Code Block
   language bash
   aviso listen listener_diss.yaml #or aviso listen listener_mars.yaml

...