plate_model_manager.auxiliary

Functions

check_update()

Check whether configured models have newer versions on Zenodo.

get_plate_model(model_name, data_dir)

Return a plate model instance using online lookup with local fallback.

check_update()[source]

Check whether configured models have newer versions on Zenodo.

For each model that includes both URL and Version metadata, this function compares the stored Zenodo version identifier against the latest available record version. It logs update status for each model and logs a summary when everything is up-to-date.

This function is intended for PMM server maintenance workflows.

get_plate_model(model_name: str, data_dir: str | PathLike) PlateModel | None[source]

Return a plate model instance using online lookup with local fallback.

This helper first attempts to resolve model_name through PlateModelManager. If the PMM servers are unavailable, it falls back to creating a local, read-only PlateModel from files already present in data_dir.

Parameters:
  • model_name – Name of the plate model to resolve.

  • data_dir – Directory containing downloaded plate model data.

Returns:

A PlateModel instance, or None if the model name cannot be resolved.

Example usage:

from plate_model_manager import get_plate_model

model = get_plate_model("Muller2025", data_dir="plate-models-data-dir")
if model is not None:
    print(model.get_rotation_model())
else:
    print("Model not found.")