Instructions

Use at the command line:

1. In your current working directory type source /cds/group/pcds/pyps/conda/venvs/lcls_naming_tool/bin/activate

2. To check if a PV or device name is valid pipe in the name to the tool. For example, $ echo "MR2K4:KBO:PIP:01:PUMPSIZE" | ./lcls_naming_tool.py

3. To check if a list of names is valid pipe in the file name to the tool. For example, $ cat pvlist.txt | ./lcls_naming_tool.py (names should be separated by newline characters.)

4. To view the current version add -v or --version. For example, $ echo "MR2K4:KBO:PIP:01:PUMPSIZE" | ./lcls_naming_tool.py --version

Use in a Python script:

1. In your current working directory set up the environment:

source /cds/group/pcds/pyps/conda/venvs/lcls_naming_tool/bin/activate

git clone git@github.com:pcdshub/lcls_naming_tool.git

export PYTHONPATH=$PWD/lcls_naming_tool/lcls_naming_tool

2. To call the LCLS Naming Tool module from lcls_naming_tool import load_taxons, validate

5. In your main function load_taxons() should be called first. It takes no parameters and loads all the approved taxons in JSON format. The function validate() takes a PV or device name in string format as a parameter and returns True for a valid name or False for an invalid name.

To run the web server:

ssh psca@psctlws01

cd /u1/psca/prod/apps/lcls_naming_tool

git pull

supervisorctl

supervisor> stop lcls_naming_tool

supervisor> start lcls_naming_tool

Website is hosted at https://pswww.slac.stanford.edu/lcls_naming_tool/

Requirements

• Python 3.9+

• Flask 2.2.5 (web only)

• Gunicorn 23.0.0 (web only)

Installation

Running the Tests