@opentrons/shared-data 0.0.1-alpha.1 → 0.0.1-alpha.18

package/lib/pipette/schemas/pipetteModelSpecsSchema.json

@@ -1,153 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "returnTipHeightRange": {
-            "type": "number",
-            "minimum": 0.25,
-            "maximum": 1.25
-        },
-        "idleCurrentRange": {
-            "type": "number",
-            "minimum": 0.01,
-            "maximum": 1.0
-        },
-        "xyzArray": {
-            "type": "array",
-            "description": "Array of 3 numbers, [x, y, z]",
-            "items": { "type": "number" },
-            "minItems": 3,
-            "maxItems": 3
-        },
-        "linearEquations": {
-            "description": "Array containing any number of 3-arrays. Each inner 3-array describes a line segment: [boundary, slope, intercept]. So [1, 2, 3] would mean 'where (next_boundary > x >= 1), y = 2x + 3'",
-            "type": "array",
-            "items": {
-                "type": "array",
-                "items": { "type": "number" },
-                "minItems": 3,
-                "maxItems": 3
-            }
-        },
-        "liquidHandlingSpecs": {
-            "description": "Object containing linear equations for translating between uL of liquid and mm of plunger travel. There is one linear equation for aspiration and one for dispense",
-            "type": "object",
-            "required": ["aspirate", "dispense"],
-            "additionalProperties": false,
-            "properties": {
-                "aspirate": { "$ref": "#/definitions/linearEquations" },
-                "dispense": { "$ref": "#/definitions/linearEquations" }
-            }
-        },
-        "editConfigurations": {
-            "type": "object",
-            "description": "Object allowing you to modify a config",
-            "required": ["value"],
-            "properties": {
-                "value": { "type": ["number", "array"] },
-                "min": { "type": "number" },
-                "max": { "type": "number" },
-                "units": { "type": "string" },
-                "type": { "type": "string" },
-                "displayName": { "type": "string" }
-            }
-        }
-    },
-    "type": "object",
-    "additionalProperties": false,
-    "required": ["config", "mutableConfigs"],
-    "properties": {
-        "config": {
-            "description": "Version-level pipette specifications, which may vary across different versions of the same pipette",
-            "type": "object",
-            "$comment": "Example key: 'p10_single_v1.3'",
-            "patternProperties": {
-                ".*": {
-                    "required": [
-                        "name",
-                        "top",
-                        "bottom",
-                        "blowout",
-                        "dropTip",
-                        "pickUpCurrent",
-                        "pickUpDistance",
-                        "pickUpIncrement",
-                        "pickUpPresses",
-                        "pickUpSpeed",
-                        "modelOffset",
-                        "plungerCurrent",
-                        "dropTipCurrent",
-                        "dropTipSpeed",
-                        "ulPerMm",
-                        "tipLength",
-                        "nozzleOffset"
-                    ],
-                    "additionalProperties": false,
-                    "properties": {
-                        "name": {
-                            "description": "reference to name of this version, should match a key in corresponding pipetteNameSpecs.json file",
-                            "type": "string"
-                        },
-                        "backCompatNames": {
-                            "description": "Optional reference for name of backwards compatible pipette corresponding to a key in pipetteNameSpecs.json, only relevant to gen2 pipettes",
-                            "type": "array"
-                        },
-                        "top": { "$ref": "#/definitions/editConfigurations" },
-                        "bottom": { "$ref": "#/definitions/editConfigurations" },
-                        "blowout": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTip": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpDistance": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpPresses": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpIncrement": { "$ref": "#/definitions/editConfigurations" },
-                        "pickUpSpeed": { "$ref": "#/definitions/editConfigurations" },
-                        "modelOffset": { "$ref": "#/definitions/xyzArray" },
-                        "nozzleOffset": { "$ref": "#/definitions/xyzArray" },
-                        "plungerCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTipCurrent": { "$ref": "#/definitions/editConfigurations" },
-                        "dropTipSpeed": { "$ref": "#/definitions/editConfigurations" },
-                        "ulPerMm": {
-                            "type": "array",
-                            "items": { "$ref": "#/definitions/liquidHandlingSpecs" }
-                        },
-                        "quirks": {
-                            "type": "array",
-                            "items": {
-                                "type": "string"
-                            }
-                        },
-                        "tipLength": {
-                            "type": "object",
-                            "value": { "$ref": "#/definitions/positiveNumber" }
-                        },
-                        "idleCurrent": { "$ref": "#/definitions/idleCurrentRange" },
-                        "returnTipHeight": { "$ref": "#/definitions/returnTipHeightRange" },
-                        "tipOverlap": {
-                            "type": "object",
-                            "description": "Map of tip overlap values with defaults",
-                            "required": ["default"],
-                            "$comment": "Other keys in here should be labware URIs",
-                            "properties": {
-                                "default": { "type": "number" }
-                            },
-                            "additionalProperties": { "type": "number" }
-                        }
-                    }
-                }
-            }
-        },
-        "mutableConfigs": {
-            "type": "array",
-            "description": "Array of mutable configs for a given pipette",
-            "items": { "type": "string" }
-        },
-        "validQuirks": {
-            "type": "array",
-            "description": "Array of valid quirks for a given pipette",
-            "items": { "type": "string" }
-        }
-    }
-}

package/lib/pipette/schemas/pipetteNameSpecsSchema.json

@@ -1,89 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "definitions": {
-        "positiveNumber": {
-            "type": "number",
-            "minimum": 0
-        },
-        "channels": {
-            "enum": [1, 8]
-        },
-        "displayCategory": {
-            "type": "string",
-            "enum": ["GEN1", "GEN2", "GEN3"]
-        },
-        "valuesByApiLevel": {
-            "type": "object",
-            "required": ["2.0"],
-            "additionalProperties": false,
-            "patternProperties": {
-                "^\\d\\.\\d+$": {
-                    "$ref": "#/definitions/positiveNumber"
-                }
-            }
-        },
-        "configValue": {
-            "type": "object",
-            "required": ["value", "min", "max", "valuesByApiLevel"],
-            "properties": {
-                "value": {
-                    "$ref": "#/definitions/positiveNumber",
-                    "$comment": "This key is deprecated in favor of valuesByApiLevel"
-                },
-                "min": { "$ref": "#/definitions/positiveNumber" },
-                "max": { "$ref": "#/definitions/positiveNumber" },
-                "valuesByApiLevel": { "$ref": "#/definitions/valuesByApiLevel" }
-            }
-        }
-    },
-    "description": "Model-level pipette specifications. These do not vary across different versions of the same model",
-    "type": "object",
-    "$comment": "Example key: 'p10_single'",
-    "patternProperties": {
-        ".*": {
-            "type": "object",
-            "required": [
-                "channels",
-                "displayName",
-                "defaultAspirateFlowRate",
-                "defaultDispenseFlowRate",
-                "defaultBlowOutFlowRate",
-                "maxVolume",
-                "minVolume",
-                "defaultTipracks"
-            ],
-            "additionalProperties": false,
-            "properties": {
-                "channels": { "$ref": "#/definitions/channels" },
-                "defaultAspirateFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "defaultDispenseFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "defaultBlowOutFlowRate": {
-                    "$ref": "#/definitions/configValue"
-                },
-                "displayName": { "type": "string" },
-                "displayCategory": { "$ref": "#/definitions/displayCategory" },
-                "maxVolume": { "$ref": "#/definitions/positiveNumber" },
-                "minVolume": { "$ref": "#/definitions/positiveNumber" },
-                "smoothieConfigs": {
-                    "type": "object",
-                    "description": "Runtime smoothie configs per pipette type",
-                    "properties": {
-                        "stepsPerMM": { "type": "number" },
-                        "homePosition": { "type": "number" },
-                        "travelDistance": { "type": "number" }
-                    }
-                },
-                "defaultTipracks": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        }
-    }
-}

package/python/build/lib/opentrons_shared_data/__init__.py

@@ -1,17 +0,0 @@
-"""A Python package wrapping json config definitions for the Opentrons stack.
-
-This package should never be installed on its own, only as a dependency of
-the main opentrons package
-"""
-
-import os
-
-from .load import get_shared_data_root, load_shared_data
-
-from ._version import version
-
-HERE = os.path.abspath(os.path.dirname(__file__))
-
-__version__ = version
-
-__all__ = ["__version__", "get_shared_data_root", "load_shared_data"]

package/python/build/lib/opentrons_shared_data/_version.py

@@ -1,20 +0,0 @@
-import sys
-import logging
-
-_pyversion = sys.version_info[0:2]
-
-if _pyversion >= (3, 8):
-    from importlib import metadata
-else:
-    import importlib_metadata as metadata  # type: ignore[no-redef]
-
-try:
-    version: str = metadata.version("opentrons_shared_data")  # type: ignore[attr-defined]
-except Exception as e:
-    logging.warning(
-        "Could not determine version for opentrons, may be dev install, using 0.0.0-dev"
-    )
-    logging.debug(e)
-    version = "0.0.0-dev"
-
-__all__ = ["version"]

package/python/build/lib/opentrons_shared_data/command/__init__.py

@@ -1,26 +0,0 @@
-"""opentrons_shared_data.command: functions command schemas."""
-from pathlib import Path
-import json
-import os
-import re
-
-from ..load import load_shared_data, get_shared_data_root
-
-
-def get_newest_schema_version() -> str:
-    """Get the version string of the most modern command schema currently in shared-data."""
-    command_schemas_dir = get_shared_data_root() / "command" / "schemas"
-    command_schemas = os.listdir(command_schemas_dir)
-    all_schema_versions = []
-    for schema_file_name in command_schemas:
-        schema_version_match = re.match(r"(\d+).json", schema_file_name)
-        if schema_version_match is not None:
-            all_schema_versions.append(schema_version_match.group(1))
-
-    return str(max(all_schema_versions))
-
-
-def load_schema_string(version: str) -> str:
-    """Get the string containing the command JSON schema for the given version string."""
-    path = Path("command") / "schemas" / f"{version}.json"
-    return json.dumps(json.loads(load_shared_data(path)), indent=2)