OpenHCS

OpenHCS

ハイコンテント顕微鏡画像を、再現可能な測定結果に変換します
GUI、Python、CellProfiler、ローカルエージェントで使える、レビュー可能なワークフロー

OpenHCS は、多数のウェル、サイト、チャネル、Z 面、または時点を一貫して解析する必要があるハイコンテント研究に取り組む、イメージング研究者や研究ソフトウェアチーム向けに設計されています。ソースの選択、処理ステップ、結果の定義が、インターフェイス上だけの状態、スクリプト、自動化に分散することなく、検証済みの単一のパイプラインにまとめられます。

ビジュアル編集、コード、自動化を通じてワークフローをレビュー可能な状態に保つ必要がある場合に適しています。同じパイプラインをデスクトップ GUI または Python として編集でき、対応する CellProfiler の .cppipe ファイルからインポートできるほか、ローカル MCP サーフェスを通じて構築またはレビューできます。

インストール

Windows インストーラー · macOS インストーラー · インストール方法

グラフィカルインストーラーは、OpenHCS GUI、CellProfiler との互換性、ローカル MCP サーバー、Napari、Fiji/ImageJ、Bio-Formats を含む、CPU 対応の隔離されたデスクトップ環境をセットアップします。GPU ライブラリはオプションです。

OpenHCS の使用例

UI とビューワーのギャラリーを見る · エージェントがワークフローを構築、デバッグ、実行、検査する様子を見る

OpenHCS は、コンパイルしてから実行する アーキテクチャで大規模な顕微鏡データセットを処理します。パイプラインは、処理開始前に選択した実行軸にわたって検証されるため、コストのかかる処理を長時間実行した後の失敗を防げます。GUI でパイプラインを設計し、Python にエクスポートしてコードとして編集し、再インポートできます。これにより、ビジュアルなワークフローとプログラムによるワークフローを切り替えられます。ローカル MCP は、対応するエージェントに同じワークフローモデルを公開するため、エージェントが作成したパイプラインも GUI や生成された Python で確認、編集、レビューできます。

graph LR
    subgraph Sources
        IX[ImageXpress]
        OP[Opera Phenix]
        BF[Bio-Formats]
        OM[OMERO]
    end

    subgraph OpenHCS Platform
        PD["Pipeline Designer<br/>(GUI ⇄ Code ⇄ Agent)"]
        CO["Typed Compiler<br/>(resolve + validate)"]
        EX["Bounded Worker Executor<br/>(well scheduling · multi-GPU)"]
        FN["Registry-Discovered Functions<br/>scikit-image · CuPy · pyclesperanto<br/>PyTorch · JAX · TF · CuCIM · custom"]
        PS["PolyStore<br/>(Memory ↔ Disk ↔ Zarr ↔ Stream)"]
    end

    subgraph Viewers
        NA[Napari]
        FJ[Fiji/ImageJ]
    end

    IX --> PD
    OP --> PD
    BF --> PD
    OM --> PD
    PD --> CO --> EX
    EX --> FN --> PS
    PS --> NA
    PS --> FJ

⚡ 主な機能

🧩 OpenHCS エコシステム

OpenHCS は、目的ごとに切り出され、個別に公開されている 8 つのライブラリで構成されています。それぞれが汎用的な課題を解決し、すべてが 1 つのプラットフォームに統合されています。

graph TD
    OH["OpenHCS Platform<br/>(domain wiring + pipelines)"]

    OH --> OS["ObjectState<br/>(config)"]
    OH --> AB["ArrayBridge<br/>(arrays)"]
    OH --> PS["PolyStore<br/>(I/O + streaming)"]
    OH --> ZR["ZMQRuntime<br/>(exec)"]
    OH --> QR["PyQT-reactive<br/>(Qt forms)"]
    OH --> FB["formbridge<br/>(form model + UI bridge)"]
    QR --> FB

    OS --> PI["python-introspect<br/>(signatures)"]
    OH --> MR["metaclass-registry<br/>(plugins)"]
    OH --> PC["pycodify<br/>(serialization)"]

🔬 顕微鏡と関数のサポート

処理領域：画像の前処理 · セグメンテーション · 細胞計数 · スティッチング（MIST + Ashlar GPU） · 神経突起のトレース · 形態解析 · 計測

次元性はグローバルなモードではなく、関数によって定義されます。真のボリューム セグメンテーションおよび計測の経路と、平面単位で処理する関数が共存し、後者の ラベルが Z 軸方向に暗黙的に結合されることはありません。 次元性と計測機能のリファレンスを参照してください。

🚀 クイックスタート

ほとんどのデスクトップユーザーは、 Windows インストーラー または macOS インストーラーをダウンロードしてください。 どちらのダウンロードも、ZIP ファイルの展開や既存の Python のインストールは不要です。 OpenHCS 0.7.23 以前からアップグレードする場合は、 一度限りのインストーラー移行に従ってください。

macOS が、署名も公証もされていない公式ブートストラップをブロックした場合は、 OpenHCS Installer.app を開いてから、System Settings > Privacy & Security に移動し、Security までスクロールして Open Anyway をクリックし、認証してから Open を確定してください。Gatekeeper の上書きは、公式 OpenHCS GitHub リリースから ダウンロードしたディスクイメージに対してのみ行ってください。現在の復旧手順は Apple のドキュメントを こちらで確認できます。

手動でインストールする場合は、仮想環境を作成し、グラフィカルインストーラーと同じ CPU セーフなデスクトップ環境をインストールしてください。

# Complete CPU-safe desktop environment
python -m pip install "openhcs[gui,viz,bioformats,mcp,cellprofiler-compat]"

# Launch the application
openhcs

# Launch the local MCP server over stdio
openhcs-mcp

より小規模な環境では、必要な機能だけを選択できます。

# Basic installation with GUI
python -m pip install "openhcs[gui]"

# Add Napari viewer
python -m pip install "openhcs[gui,napari]"

# Add Fiji/ImageJ viewer
python -m pip install "openhcs[gui,fiji]"

# Add both viewers
python -m pip install "openhcs[gui,viz]"

# Add GPU acceleration on a compatible CUDA 12 system
python -m pip install "openhcs[gui,gpu]"

# Full installation (GUI + viewers + GPU)
python -m pip install "openhcs[gui,viz,gpu]"

# Add the local MCP server for agent clients
python -m pip install "openhcs[gui,mcp,viz]"

# Or lower a CellProfiler pipeline into public OpenHCS declarations
from pathlib import Path

from objectstate import ensure_global_config_context
from openhcs.core.config import GlobalPipelineConfig
from openhcs.core.orchestrator.orchestrator import PipelineOrchestrator
from openhcs.interop.cellprofiler.pipeline_import import import_cellprofiler_pipeline

plate_path = Path("/data/plate").resolve()
ensure_global_config_context(GlobalPipelineConfig, GlobalPipelineConfig())
steps, pipeline_config = import_cellprofiler_pipeline(
    "analysis.cppipe",
    source_root=plate_path,
)

orchestrator = PipelineOrchestrator(
    plate_path,
    pipeline_config=pipeline_config,
).initialize()
execution_bundle = orchestrator.compile_pipelines(steps)

GUI と実行サービスは、同じ list[FunctionStep]、 PipelineConfig、型付き実行バンドルを使用します。明示的な低レベル実行呼び出しと 進行状況のライフサイクルについては、API の概要をご覧ください。

CellProfiler/OpenHCS の比較を実行するメンテナーは、パッケージに含まれる openhcs-benchmark コマンドを使用できます。openhcs-benchmark list-cases --manifest PATH は、データを取得したり実行を開始したりせずに、宣言されたケースのソースを確認します。エキスパート向けの openhcs_list_benchmark_cases MCP ツールでは、同じ選択機能を利用できます。 比較の実行ごとに、ライフサイクル状態、正確な再実行コマンド、宣言された処理、 構造化された結果アーティファクトを含む、型付きレシートが記録されます。 新規または空の出力ディレクトリを使用してください。使用中のディレクトリは、実行によるマニフェストの読み込み前に拒否されます。 エキスパート向けの full MCP サーフェスでは、 openhcs_inspect_benchmark_run を使用して、ローカルの読み取りパスのポリシーで許可された既存の結果ディレクトリを調べることができます。 openhcs-benchmark inspect-run --output-dir PATH も同じ型付き検査を行います。 どちらの経路も、上限のない一覧を返す代わりに、artifact_limit と artifact_offset を使用して構造化アーティファクトをページ分割します。 openhcs_report_benchmark_run と openhcs-benchmark inspect-run --output-dir PATH --report は、型付きレシートと観測結果から、ケースごとの結果を上限付きで表示します。これらの MCP 経路は読み取り専用です。ベンチマークの起動、再開、キャンセル、再実行は行わず、記録されたレシートは来歴情報であり、科学的な同等性を示す主張ではありません。 単一の通常の測定済みパイプラインについては、openhcs-benchmark inspect-measured --output-dir PATH とエキスパート向け MCP 検査・レポートツールが、同じ 検証済み実行レシートを読み取り、保持されているソース、観測結果、要約のダイジェストを確認します。 後者 2 つのダイジェストがないアーカイブ済みレシートも読み取り可能ですが、これらのファイルは検証できません。これらの経路によって、 2 つ目のパイプラインランナーやジョブステータスシステムが作られることはありません。 openhcs-benchmark run-measured --plate PLATE --pipeline-source-file PIPELINE.py --output-dir EVIDENCE --run-id ID --wait-timeout-ms 120000 は、通常のヘッドレスジョブ制御を通じて パイプラインを送信し、その後 MCP と同じレシートの最終処理を呼び出します。入力ワークスペースを 別途準備している場合は --execution-plate PREPARED_PLATE を使用してください。証拠ディレクトリは空である必要があります。 --observation-scope outcomes を使用すると、実行時配列を転送せずに軸ごとの成功と来歴を保持できます。この機能は出力値を比較しません。 通常のヘッドレスジョブが完了した後、エキスパート向けの openhcs_finalize_measured_pipeline_run ツールを使用すると、実行時の観測結果を検証し、正確に送信されたパイプラインとサーバーの完了記録からそのレシートを保持できます。 このツールは別のジョブを送信しません。

python -m pip install "openhcs"              # Headless engine
python -m pip install "openhcs[gui]"         # Desktop GUI
python -m pip install "openhcs[gui,napari]"  # GUI + Napari viewer
python -m pip install "openhcs[gui,viz]"     # GUI + Napari + Fiji
python -m pip install "openhcs[gui,viz,gpu]" # Full installation
python -m pip install "openhcs[gpu]"         # Headless + GPU
python -m pip install "openhcs[omero]"       # OMERO integration
python -m pip install -e ".[all,dev]"         # Development (all features)

python scripts/install_omero_deps.py
pip install 'openhcs[omero]'

pip install -r requirements-omero.txt
pip install 'openhcs[omero]'

📖 ドキュメント

⚙️ アーキテクチャのハイライト

PipelineConfig + list[FunctionStep]
        ↓ resolve once
StepSnapshot + CompilationSession
        ↓ derive and validate
typed CompiledStepPlan objects
        ↓ package
CompiledExecutionBundle
        ↓ execute
runtime values + materialized artifacts

Function patterns · Individual steps · Pipeline configs · Full orchestrator scripts
              ↕  generate / AST-parse back  ↕

🤝 コントリビューション

git clone --recurse-submodules https://github.com/OpenHCSDev/OpenHCS.git
cd OpenHCS
# Install the eight local packages using docs/source/development/repository_setup.rst,
# then install OpenHCS itself:
python -m pip install -e ".[dev,gui]"
OPENHCS_CPU_ONLY=1 python -m pytest tests/unit

コントリビューション分野：顕微鏡フォーマット · 処理関数 · GPU バックエンド · ドキュメント

📄 ライセンス

MIT — LICENSE を参照してください。

🙏 謝辞

OpenHCS は EZStitcher を発展させたもので、Ashlar（スティッチング）、MIST（位相相関）、pyclesperanto（GPU 画像処理）、scikit-image（画像解析）を基盤としています。

OpenHCS の CellProfiler との相互運用性および同等性検証は、CellProfiler プロジェクトのオープンソースソフトウェア、ドキュメント、公開されているサンプル、チュートリアル、ベンチマーク資料を基盤としています。CellProfiler の著者と貢献者、および同プロジェクトが配布する生物学的データセットの著者に感謝いたします。Stirling et al., CellProfiler 4: improvements in speed, utility and usability (2021) を含め、CellProfiler の公式引用ガイドラインに従って引用してください。

サードパーティプロジェクトの名称とロゴは、OpenHCS がサポートする統合、互換性のある クライアント、または OpenHCS が使用するソフトウェアを示すものです。それらは引き続き、 各プロジェクトまたは所有者の財産です。これらの表示は、提携や推奨を意味するものでは ありません。