cycle_metadata_logger

Python & Tkinter GUI for recording metadata that goes alongside lyophilization runs. An initial draft was authored by Petr Kazarin and ChatGPT; expanded significantly and improved by Isaac S Wheeler.

What you do:

1. Download the file
2. Fill out all the run information, including indicating process data files and a folder to save the metadata
3. Click "Finish"

What you get:

A YAML file with the cycle metadata, placed in a folder with any chosen process data files. The given file names are as follows:

YYYY-MM-DD-HH_LYO_UU.yaml Breakdown:

• YYYY-MM-DD-HH is a timestamp, including hours in case multiple are run in a day
• LYO will be e.g. LS, LC, MFD, or REVO, indicating which machine was used
• UU will be user initials

If only one process file is included, it will be named as YYYY-MM-DD-HH_LYO_UU.csv; multiple will be named YYYY-MM-DD-HH_LYO_UU_1.csv, YYYY-MM-DD-HH_LYO_UU_2.csv

Default options

For the early life of this system, the choices of lyophilizer, formulation, project, and container size had defaults hardcoded into the program. The directory in which files would be saved was likewise hardcoded. As of 0.4, however, if the executable finds a file called persistent_options.yaml, it will read in that file. You can open that file and add or remove items from that list to add or remove items from the dropdown boxes, as suits your convenience.

How to improve this system:

Assuming you are a future LyoHUB user: make changes and upload to this repo, then pull them down to the instance of this repo on depot\lyohub\data\cycle_metadata_logger. Then, follow an appropriate set of instructions below. Be warned that if you use a git pull to copy the files, this will likely override the persistent_options.yaml which is currently there. It would be prudent to make a copy of that file elsewhere, update, then put the desired version back in.

Installation

Windows 7 (or presumably other OS) install

1. Log onto a computer with Windows 7 (any of the ones in the lab could be used, but the FDM computer already has everything necessary installed)
2. Download this repository, then navigate to its base directory
3. In a terminal with Python, run pyinstaller metadata_writer.spec
4. In a regular file explorer window, find the executable in cycle_metadata_logger\dist, and check its file permissions: "everyone" should be able to "read and execute" (this is not the default)
5. Place the desired copy of persistent_options.yaml in the directory with the executable

Windows 10

1. Download metadata_writer.exe from the most recent release on GitHub
2. Look at the release to find the executable
3. Download the executable and place where you want it

Wishlist:

• Add a search capability across a folder of metadata to identify historical runs with particular sets of metadata, e.g. for a specific project or using a particular formulation.