pcdshub / pcdshub/pcdsutils

External script support: get_info

Open
#48 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2
Forks
6
Avg merge
7d 11h
Merged PRs (30d)
1

Description

Could add to our ext_scripts:
https://github.com/pcdshub/pcdsutils/blob/e8b308c08afdfa8d4bc0f75d07deea2f46704a39/pcdsutils/ext_scripts.py#L1

get_info does a lot of stuff, including the ability to access which hutch station you're on:

(pcds-5.3.0) [klauer@psbuild-rhel7-01  typhos]$ get_info --help
usage: get_info [-h] [--run] [--exp] [--live] [--ended] [--hutch HUTCH]
                [--station STATION] [--getHutch] [--gethutch] [--getstation]
                [--getbase] [--getinstrument] [--getcnf]
                [--files_for_run FILES_FOR_RUN]
                [--nfiles_for_run NFILES_FOR_RUN] [--setExp SETEXP]

optional arguments:
  -h, --help            show this help message and exit
  --run                 get last run
  --exp                 get experiment name
  --live                ongoing?
  --ended               ended
  --hutch HUTCH         get experiment for hutch xxx
  --station STATION     optional station for hutch with two daqs, e.g. cxi and
                        mfx
  --getHutch            get hutch (uppercase)
  --gethutch            get hutch (lowercase)
  --getstation          get hutch station (for multiple daqs)
  --getbase             get base daq name (hutch_station if multiple daqs,
                        otherwise hutch)
  --getinstrument       get instrument (HUTCH_station if multiple daqs,
                        otherwise hutch)
  --getcnf              get cnf file name)
  --files_for_run FILES_FOR_RUN
                        get xtc files for run
  --nfiles_for_run NFILES_FOR_RUN
                        get xtc files for run
  --setExp SETEXP       set experiment name

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the referenced pcdsutils/ext_scripts.py and comparing its existing external-script support with the get_info command and options listed in the issue. Confirm which get_info behavior belongs in ext_scripts, then verify that the requested hutch, station, run, experiment, and file-related operations are exposed and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.