Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
labelsI want to create/update my archfile

General Usage

The questionnaire is a form that is filled out between the experiment POC and the controls POC. IT contains the requested setup for every aspect of the experiment, including the motors, lasers, cameras and vacuum components. 

The questionnaire is available here through the pswww interface. There is a questionnaire for each run and the proposal catalog lists all of the experiments. Note, some experiments are listen in multiple runs. 

Code Block
$ epicsarch-qs exp_name 

If no hutch is passed it will extract from the experiment name. 

Optional Args

  • path - allows user to specify a specific path for an archfile to be created/updated
    • If no path is provided it will default to: 

      Default path: /cds/group/pcds/dist/pds/[HUTCH]/misc/

  • dry-run - prints preview to the console of what will be included in the experiment archfileImage Added


  • softlink - updates the softlink to the epicsArch_experiment_specific.txt

Image Added

  • linkpath - provides user with the option to supply custom file path for softlink.
  • cds items - gets current data from the questionnaire API via psdm client

Image AddedImage Added

  • level - more for developers and troubleshooting, allows the user to specify a debugging level.

Image Added


Useful Info:

EngGen_04032024.pptx

Current Functionality of epicsArch tools:

epicsarch-qs 

Overview of epics-arch.py

create arch file

  • cli_setup - handles the setup of the logger
  • create arch file - decides which function to call depending on the command line args
    • experiment and not dry run 
      • path - checks for a valid path, if valid, sets the new path 
      • hutch - edits file_path to a specific hutch
      • cds items - launches pull_client (params: experiment, cds_items) this method interfaces with the questionnaire to get proposal details from the entire cds tab
      • link - launches create_softlink (params: experiment)
      • defaults to setting the filepath and updating the archfile
    • dry run - prints dry run

pull client

create soft link

check for duplicates 

read archfile

print dry run

get key

get questionnaire data