Plexora
Python APIProjects and samples

project_from_spec

Register one project from a spec dict.

Generated from Plexora 0.0.55View source
from plexora import project_from_spec
project_from_spec(spec, node=None) -> str

The same as create_project(**spec) -- this is what the CLI's --from file.json and create_dataset(projects=[...]) both call, so a spec document means one thing everywhere it is read.

Parameters

specdictrequired

A project spec: any of PROJECT_SPEC_KEYS, with image required.

nodestrdefault None

The data node any path in spec is on, unless the spec says otherwise for itself.

Returns

str

The project's name -- see create_project.

Raises

ValueError

See create_project.

Examples

import plexora

name = plexora.project_from_spec({"image": "slide.ome.tif", "data": "cells.csv"})

create_project

Register one project and return its name.

PROJECT_SPEC_KEYS

Every key a project may be defined with, in one place, so the Python API, the CLI and any --from spec.json all accept exactly the same vocabulary. A caller that knows this tuple knows the whole schema.

project_manifest

What one project has, what it was told, and what is still open.

PROJECT_SPEC_KEYS

Every key a project may be defined with, in one place, so the Python API, the CLI and any --from spec.json all accept exactly the same vocabulary. A caller that knows this tuple knows the whole schema.

On this page

ParametersReturnsRaisesExamplesRelated