Skip to main content

Installation

Preview: not yet released

Orca Framework has not been released yet, so there is no public install. Access to the preview package is by request for evaluation. Contact us to get set up.

Orca Framework is a Python package. It is not on public PyPI; the preview is distributed as a package or source access provided with your evaluation.

Prerequisites​

  • Python 3.10 or higher — check with python --version. If you're on an older version, python.org/downloads has the installer.
  • pip — usually comes with Python.
  • Git — for cloning the source if you're installing that way.
  • A virtual environment — recommended for any Python project. See "Set up a virtual environment" below.

You don't need any lab hardware to install or try Orca Framework. Everything works in simulation out of the box.

Set up a virtual environment​

A virtual environment keeps Orca's dependencies isolated from the rest of your system. Skip this if you already have one for your project.

python -m venv .venv

# Mac / Linux
source .venv/bin/activate

# Windows (PowerShell)
.venv\Scripts\Activate.ps1

Once activated, your prompt will usually show (.venv) to indicate the environment is active.

Install Orca Framework​

Contact us for access. Your access email includes the private package index (or wheel) and the source repository URL.

Install from the provided package index once you have access:

pip install cheshire-orca --index-url <private-index-url-from-your-access-email>

Or, from source:

git clone <repo-url-from-your-access-email>
cd orca-framework
pip install -e .

Verify the install​

orca version

Or check the installed package metadata directly:

python -c "from importlib.metadata import version; print(version('cheshire-orca'))"

You should see a version number printed. If you get ModuleNotFoundError or a PackageNotFoundError, the install didn't complete or your virtual environment isn't active.

What gets installed​

Orca Framework brings in its dependencies automatically:

  • cheshire-drivers: driver interfaces (IShaker, ITransporter, etc.) and simulation backends. This is a direct dependency.
  • PyLabRobot: hardware abstraction for instruments, used by drivers to talk to real devices and simulate them. It rides in transitively through cheshire-drivers.

You don't have to import or configure these directly; Orca uses them under the hood.

Next steps​

  • Quick Start — run your first workflow in simulation.
  • Architecture — get the conceptual model before writing code.