BCDA-APS / use_bluesky

Tools to help APS use the Bluesky Framework (https://blueskyproject.io/)
8 stars 3 forks source link

update the template for new Bluesky setups #88

Closed prjemian closed 3 years ago

prjemian commented 3 years ago

While configuring for new use at 30-ID, found the current installation procedure for a new instrument package needed significant additional configuration.

Suggest a refactor, starting from new setup for 30-ID, and adding a bash shell installation script that modifies the required files with the local instrument specifics (instrument name, databroker catalog name, ...).

The revisions can be tested with a new installation at 16-ID this week.

prjemian commented 3 years ago

Installation shell script needs to replace these symbols:

symbol file meaning
CATALOG_NAME startup/instrument/framework/initialize.py databroker catalog to use on startup
BEAMLINE_NAME startup/instrument/framework/metadata.py beam line name, for run metadata
INSTRUMENT_NAME startup/instrument/framework/metadata.py instrument name, for run metadata
INSTRUMENT_NAME startup/README.md instrument name

In startup/blueskyStarter.sh:

Looks easy, peasy for a shell script with sed.