Convert MIHCSME (Minimum Information about a High Content Screening Microscopy Experiment) metadata from Excel spreadsheets to validated Pydantic models and upload to OMERO.
- Parse MIHCSME Excel templates into type-safe Pydantic models
- Automatic validation with clear error messages
- Bidirectional conversion between Excel, Pydantic, and OMERO key-value pair format
- Modern CLI with rich terminal output
- OMERO.script for server-side handling of MIHCSME templates
# Clone the repository
git clone https://github.com/Leiden-Cell-Observatory/MIHCSME_OMERO.git
cd MIHCSME_OMERO
# Create virtual environment with uv
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install in editable mode with dev dependencies
uv pip install -e ".[dev]"uv pip install mihcsme-py# Validate MIHCSME Excel file
mihcsme validate LEI-MIHCSME.xlsx
# Parse Excel to JSON
mihcsme parse LEI-MIHCSME.xlsx --output metadata.json
# Upload to OMERO Screen
mihcsme upload LEI-MIHCSME.xlsx \
--screen-id 123 \
--host omero.example.com \
--user myuser
# Upload with replace (removes existing annotations)
mihcsme upload LEI-MIHCSME.xlsx \
--plate-id 456 \
--host omero.example.com \
--user myuser \
--replacefrom pathlib import Path
from mihcsme_omero import connect, parse_excel_to_model, upload_metadata_to_omero
# Parse Excel file to Pydantic model
excel_path = Path("LEI-MIHCSME.xlsx")
metadata = parse_excel_to_model(excel_path)
# Inspect the model
print(f"Wells: {len(metadata.assay_conditions)}")
for condition in metadata.assay_conditions:
print(f"{condition.plate} / {condition.well}: {condition.conditions}")
# Connect to OMERO
conn = connect(
host="omero.example.com",
user="myuser",
password="mypassword",
port=4064,
secure=True,
)
# Upload to OMERO
result = upload_metadata_to_omero(
conn=conn,
metadata=metadata,
target_type="Screen",
target_id=123,
namespace="MIHCSME",
replace=False,
)
print(f"Status: {result['status']}")
print(f"Wells succeeded: {result['wells_succeeded']}")
conn.close()| Notebook | What it shows |
|---|---|
examples/marimo/mihcsme_app.py |
Flagship app: load Excel, plate editor, metadata forms, export, OMERO validate/upload with per-plate status |
examples/marimo/01_parse_and_explore.py |
Excel → validated model → well table → Excel / filled template |
examples/marimo/02_omero_roundtrip.py |
Validate, upload and download metadata on an OMERO Screen |
examples/marimo/03_llm_fill.py |
Fill Investigation/Study/Assay information from lab notes with an LLM |
Run the app locally: uvx marimo run --sandbox examples/marimo/mihcsme_app.py
The MIHCSME Excel file should contain these sheets:
- InvestigationInformation - Investigation-level metadata (grouped key-value pairs)
- StudyInformation - Study-level metadata (grouped key-value pairs)
- AssayInformation - Assay-level metadata (grouped key-value pairs)
- AssayConditions - Per-well metadata (tabular: Plate, Well, conditions...)
- _Reference sheets - Reference data (sheets starting with
_)
See LEI-MIHCSME.xlsx for an example.
The package uses Pydantic models for type-safe metadata handling:
from mihcsme_omero.models import MIHCSMEMetadata, AssayCondition
# Create metadata programmatically
metadata = MIHCSMEMetadata(
assay_conditions=[
AssayCondition(
plate="Plate1",
well="A1", # Automatically normalized to "A01"
conditions={"Compound": "DMSO", "Concentration": "0.1%"},
)
]
)
# Convert to OMERO dict format
omero_dict = metadata.to_omero_dict()
# Create from OMERO dict format
metadata = MIHCSMEMetadata.from_omero_dict(omero_dict)# Run all tests
pytest
# Run with coverage
pytest --cov=mihcsme_omero --cov-report=html
# Run type checking
mypy src/mihcsme_omero
# Format code
black src/ tests/
# Lint code
ruff check src/ tests/ --fixmihcsme-omero/
├── src/mihcsme_omero/ # Source code (src layout)
│ ├── __init__.py # Package exports
│ ├── models.py # Pydantic models
│ ├── parser.py # Excel → Pydantic
│ ├── omero_connection.py # OMERO connection utilities
│ ├── uploader.py # Pydantic → OMERO
│ └── cli.py # Typer CLI
├── tests/ # Test suite
├── original_scripts/ # Legacy scripts (reference only)
├── pyproject.toml # Package configuration
└── README.md # This file
Contributions are welcome! Please:
- Fork the repository
- Create a feature branch (
git checkout -b feature/my-feature) - Make changes with tests
- Run quality checks (
black,ruff,mypy,pytest) - Commit with clear message
- Push and create pull request
See LICENSE file for details.