diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 8da0272..be4fa1d 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/user-guide/installation.doctree b/.doctrees/user-guide/installation.doctree index 3ae76c5..fdc3254 100644 Binary files a/.doctrees/user-guide/installation.doctree and b/.doctrees/user-guide/installation.doctree differ diff --git a/_sources/user-guide/installation.rst.txt b/_sources/user-guide/installation.rst.txt index 736ce25..e9f4af7 100644 --- a/_sources/user-guide/installation.rst.txt +++ b/_sources/user-guide/installation.rst.txt @@ -36,7 +36,7 @@ PDM is used as the project manager for EOS, making it easier to install dependen ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: shell - git clone https://github.com/aangelos28/eos + git clone https://github.com/UNC-Robotics/eos 3. Install Dependencies ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/searchindex.js b/searchindex.js index 54d4247..7cc4d27 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"1. Configure External Services": [[2, "configure-external-services"]], "1. Install PDM": [[6, "install-pdm"]], "1. Start External Services": [[11, "start-external-services"]], "2. Clone the EOS Repository": [[6, "clone-the-eos-repository"]], "2. Configure EOS": [[2, "configure-eos"]], "2. Source the Virtual Environment": [[11, "source-the-virtual-environment"]], "3. Install Dependencies": [[6, "install-dependencies"]], "3. Start the EOS Orchestrator": [[11, "start-the-eos-orchestrator"]], "4. Start the EOS REST API": [[11, "start-the-eos-rest-api"]], "Advanced": [[5, null]], "Automation Setup (Make and Test Phases)": [[1, "automation-setup-make-and-test-phases"]], "Boolean": [[12, "boolean"]], "Campaigns": [[1, null]], "Choice": [[12, "choice"]], "Computers (Optional)": [[8, "computers-optional"]], "Concepts": [[5, null]], "Configuration": [[2, null]], "Containers": [[12, "containers"]], "Containers (Optional)": [[8, "containers-optional"]], "Create a Package": [[10, "create-a-package"]], "Decimal": [[12, "decimal"]], "Device Implementation": [[3, "device-implementation"]], "Devices": [[3, null]], "Devices (Required)": [[8, "devices-required"]], "Dictionary": [[12, "dictionary"]], "Distributed Execution": [[9, "distributed-execution"]], "Example Custom Optimizer": [[9, "example-custom-optimizer"]], "Experiment Implementation": [[4, "experiment-implementation"]], "Experiments": [[4, null]], "Files": [[12, "files"]], "Getting Started": [[5, null]], "Input and Output Parameter Naming": [[9, "input-and-output-parameter-naming"]], "Installation": [[6, null]], "Integer": [[12, "integer"]], "Jinja2 Templating": [[7, null]], "Laboratories": [[8, null]], "Laboratory Implementation": [[8, "laboratory-implementation"]], "List": [[12, "list"]], "Locations (Optional)": [[8, "locations-optional"]], "Optimization Setup (Analyze and Design Phases)": [[1, "optimization-setup-analyze-and-design-phases"]], "Optimizer File (optimizer.py)": [[4, "optimizer-file-optimizer-py"]], "Optimizer Implementation": [[9, "optimizer-implementation"]], "Optimizers": [[9, null]], "Packages": [[10, null]], "Parameter Specification": [[12, "parameter-specification"]], "Parameters": [[12, "parameters"]], "Python File (device.py)": [[3, "python-file-device-py"]], "Python File (task.yml)": [[12, "python-file-task-yml"]], "Running": [[11, null]], "String": [[12, "string"]], "Task Implementation": [[12, "task-implementation"]], "Tasks": [[12, null]], "The Experiment Orchestration System (EOS)": [[0, null]], "User Guide": [[0, null], [5, null]], "YAML File (device.yml)": [[3, "yaml-file-device-yml"]], "YAML File (experiment.yml)": [[4, "yaml-file-experiment-yml"]], "YAML File (task.yml)": [[12, "yaml-file-task-yml"]]}, "docnames": ["index", "user-guide/campaigns", "user-guide/configuration", "user-guide/devices", "user-guide/experiments", "user-guide/index", "user-guide/installation", "user-guide/jinja2_templating", "user-guide/laboratories", "user-guide/optimizers", "user-guide/packages", "user-guide/running", "user-guide/tasks"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "user-guide/campaigns.rst", "user-guide/configuration.rst", "user-guide/devices.rst", "user-guide/experiments.rst", "user-guide/index.rst", "user-guide/installation.rst", "user-guide/jinja2_templating.rst", "user-guide/laboratories.rst", "user-guide/optimizers.rst", "user-guide/packages.rst", "user-guide/running.rst", "user-guide/tasks.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [1, 3, 4, 12], "0": [1, 4, 8, 9, 12], "1": [1, 4, 5, 8, 9, 12], "10": [1, 4, 8, 9], "100": 8, "1000c": 8, "100mw": 8, "101": 8, "102": 8, "103": 8, "127": 8, "15": [1, 4, 9], "150": 12, "168": 8, "192": 8, "192000": 12, "2": [5, 9, 12], "20": 8, "25": 12, "3": 5, "300": 7, "4": [5, 12], "44100": 12, "480": 12, "5": [1, 4, 8, 9, 12], "50": [1, 4, 9, 12], "500": [1, 4, 9], "5004": 3, "5g": 8, "7": 12, "8": 12, "8000": 12, "A": [0, 1, 3, 8, 12], "As": 4, "But": 3, "By": 10, "For": [1, 3, 4, 10], "If": [1, 4, 6, 8], "In": [1, 3, 4, 9, 12], "It": [1, 9, 10, 12], "No": 8, "One": 9, "The": [1, 3, 4, 7, 8, 9, 12], "Then": 3, "There": [1, 3, 4, 8, 12], "These": [8, 10], "_": 9, "__init__": 9, "_cleanup": 3, "_execut": 12, "_initi": 3, "_report": 3, "aangelos28": 6, "abl": 9, "about": [1, 8], "abov": [3, 4], "abstract": 3, "abstract_sequential_optim": [1, 4, 9], "abstractsequentialoptim": [1, 4, 9], "accept": 12, "access": 6, "achiev": 9, "acquisit": 9, "acquisition_funct": [1, 4, 9], "across": [0, 4, 10, 12], "act": 12, "activ": [9, 11], "actor": [9, 12], "acycl": 4, "addit": [1, 4, 8, 10, 12], "address": 8, "adjac": [1, 9], "after": 2, "ag": 8, "ag_cruc": 8, "aggreg": 0, "ai": 3, "al": 8, "algorithm": 1, "all": [1, 2, 3, 4, 6, 8, 9, 10, 12], "alloc": 0, "allow": [1, 7, 8, 10], "along": 9, "also": [1, 3, 4, 6, 9, 10, 12], "alwai": [3, 8], "am1": 8, "amino": 12, "an": [1, 3, 4, 8, 9, 10, 12], "analysi": [8, 12], "analysis_tim": 12, "analyz": [4, 5], "analyze_color": 4, "ani": [1, 3, 4, 8, 9, 12], "anneal": 8, "annealing_st": 8, "anoth": [1, 10], "anyth": 3, "api": 5, "apparatu": 3, "apparatus": 8, "append": 9, "ar": [1, 2, 3, 4, 7, 8, 9, 10, 12], "area": 12, "argument": [4, 9, 12], "arm": [1, 4], "around": 8, "assign": 12, "associ": 9, "au": 8, "au_cruc": 8, "author": 7, "authorit": 0, "auto": 12, "auto_calibr": 12, "autom": [0, 3, 5, 6, 8], "automat": 0, "autonom": [1, 9], "avail": 4, "axi": 9, "b": [1, 7], "back": 4, "base": [1, 4, 9, 12], "base_devic": 3, "base_task": 12, "basedevic": 3, "basetask": 12, "batch": 8, "bayesian": [0, 1, 9], "bayesiansequentialoptim": [1, 4, 9], "beaker": [4, 7, 12], "beaker_500ml": 12, "befor": [4, 12], "below": [3, 4, 7, 8, 9, 10, 12], "between": [1, 4], "bi": 6, "bin": 11, "black": 9, "black_volum": [1, 4, 9], "block": 12, "blue": [1, 4], "bofir": [1, 4, 9], "bool": 12, "boolean": 5, "both": [1, 3, 9], "botorch": 9, "bound": [1, 4, 9], "box": 9, "branch": 1, "budibas": 6, "buffer": 12, "buffer_composit": 12, "build": [6, 9, 12], "built": [0, 1, 9], "c": 7, "c18": 12, "c8": 12, "c_": 7, "c_a": 4, "c_b": 4, "c_c": 4, "c_d": 4, "c_e": 4, "cacl2": 12, "calibr": 12, "call": [1, 3, 4, 8, 10, 12], "campaign": [0, 4, 5, 8, 9], "can": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12], "cannot": 12, "capabl": [6, 8, 9], "capac": [7, 8], "care": 1, "case": [3, 12], "cd": 11, "cell": 8, "central": [0, 6, 8], "chamber": 8, "channel": 12, "channel_gain": 12, "charact": 12, "character": 8, "characterization_room": 8, "choic": 5, "chosen": 4, "chromatographi": [3, 12], "class": [3, 4, 9, 12], "clean": [3, 4], "clean_contain": 4, "cleaner": 8, "cleaning_st": 4, "clear": 12, "client": [3, 10], "clone": 5, "close": 1, "close_connect": 3, "cm2": 8, "cmyk": [1, 4], "coat": 8, "coater": 8, "code": [0, 3, 10, 12], "collect": 8, "color": [1, 4, 9], "color_analyz": 4, "color_dispens": 4, "color_lab": [3, 4, 8, 10], "color_mix": [4, 10], "column": [9, 12], "column_typ": 12, "com": 6, "command": [3, 10], "common": [0, 1, 3, 9, 10], "commun": [0, 3, 10], "compar": 1, "compat": 12, "complex": 7, "compon": 1, "compos": [1, 2, 6, 11], "composit": 12, "comprehens": 0, "comput": [5, 6, 9], "concat": 9, "concentr": 12, "condit": 7, "config": 2, "configur": [0, 5], "conflict": 0, "connect": [3, 6, 8], "constrain": 9, "constraint": [1, 4, 9, 12], "constructor": [4, 9], "constructor_arg": [1, 4, 9], "contain": [0, 1, 3, 4, 5, 7, 9, 10], "container_storag": [4, 7], "containerstyp": 12, "content": [3, 6], "continu": [1, 4, 9], "continuousinput": [1, 4, 9], "continuousoutput": [1, 4, 9], "contract": 12, "contribut": 6, "control": [0, 8], "coordin": 8, "copi": 2, "correct": 12, "could": [3, 4, 12], "cp": 2, "creat": [1, 3, 5, 9, 12], "credenti": 2, "crucibl": 8, "crystal": 8, "curl": 6, "current": 12, "curv": 8, "custom": [1, 5], "cyan_volum": [1, 4, 9], "d": [7, 11], "dag": 4, "data": [3, 8, 10, 12], "data_model": [1, 4, 9], "databas": 6, "dataclass": 9, "datafram": 9, "decim": [1, 5], "dedic": [3, 9], "def": [1, 3, 4, 9, 12], "default": [10, 12], "defin": [0, 4, 7, 8, 9, 12], "definit": [3, 10, 12], "delet": 10, "denot": 4, "depend": [1, 4, 5], "deposit": 8, "descript": [1, 3, 4, 8, 12], "design": [0, 5], "desir": 4, "detail": 3, "detect": 12, "determin": 3, "dev": 6, "develop": 6, "devic": [0, 1, 4, 5, 7, 10, 12], "device_cli": 3, "device_typ": 12, "devicecli": 3, "devicestyp": 12, "df": 9, "dict": [1, 3, 4, 9, 12], "dictionari": 5, "differ": [1, 4, 8, 9, 12], "diffractomet": 8, "direct": [4, 6], "directori": 10, "discov": [3, 10, 12], "dispens": 4, "dispense_color": [1, 4, 9], "dissect": 4, "distil": 4, "distribut": [0, 5], "dmta": 1, "doc": 6, "docker": [2, 6, 11], "document": [6, 12], "don": 10, "download": 12, "draw": 9, "drive": [0, 1], "driver": [3, 10], "dure": [7, 12], "dynam": [0, 1, 4, 12], "e": [3, 4, 7, 8, 12], "each": [1, 3, 4, 8, 9, 10, 12], "easier": [6, 7], "easili": 6, "edg": 4, "edit": 2, "either": 4, "electrod": 8, "element": 12, "element_typ": 12, "elementari": 12, "els": 9, "empti": 4, "empty_contain": 4, "emptying_loc": 4, "enabl": [7, 9], "encapsul": [1, 12], "end": [3, 12], "endfor": 7, "enforc": 12, "ensur": [1, 2, 6, 12], "entiti": 3, "enum": [1, 4, 9], "env": [2, 11], "environ": [2, 5], "eo": [1, 3, 4, 5, 7, 8, 9, 10, 12], "eos_comput": 8, "eos_create_campaign_optim": [1, 4, 9], "eos_dynam": [1, 4], "ephemer": 12, "equip": [8, 10], "equival": 12, "especi": 9, "essenti": [4, 10], "etc": 12, "evalu": [7, 9], "evapor": 8, "evaporation_chamb": 8, "even": 1, "everi": [3, 4, 8, 12], "exampl": [1, 2, 3, 4, 5, 8, 10, 12], "execut": [0, 1, 4, 5, 12], "exist": 8, "expect": [1, 10], "expens": 9, "experi": [1, 3, 5, 7, 8, 9, 10], "experiment": 1, "experiment_": 12, "express": 7, "extens": 0, "extern": [5, 12], "fabric": 8, "fals": 12, "featur": [1, 4, 9], "feedback": 3, "feeder": 4, "feel": 10, "field": 2, "figur": 3, "file": [0, 1, 2, 5, 6, 7, 8, 9, 10], "file_prefix": 12, "fill": 8, "find": 4, "first": 4, "five": 4, "float": [9, 12], "folder": 10, "follow": 12, "form": 4, "format": 9, "forward": 9, "found": [1, 4], "foundat": 0, "four": 4, "framework": 0, "free": 10, "from": [1, 2, 3, 4, 9, 10, 12], "fulli": 4, "fume": 8, "fume_hood": 8, "function": [1, 3, 4, 9, 12], "futur": 12, "g": [3, 4, 6, 8, 12], "ga": [3, 12], "gain": 12, "gaussian": 9, "gc": [3, 12], "gener": [4, 12], "get": 4, "get_all_by_typ": 12, "get_input_nam": 9, "get_optimal_solut": 9, "get_output_nam": 9, "git": 6, "github": 6, "give": 9, "given": [3, 12], "global": 12, "glovebox": 8, "go": 8, "goal": 1, "gp": 9, "graph": 4, "green": [1, 4], "group": 8, "guid": [4, 6], "guidelin": 1, "ha": [1, 3, 4, 6, 8, 9, 12], "have": [1, 8, 12], "here": 8, "hexyl": 12, "highest": 1, "hilic": 12, "hold": 8, "home": 12, "hood": 8, "host": 8, "hotplat": 8, "how": [1, 8, 12], "howev": [9, 12], "hplc": 12, "http": 6, "hz": 12, "i": [0, 1, 3, 4, 6, 7, 8, 9, 10, 12], "id": [4, 7, 8, 12], "ident": [1, 4, 9], "identifi": [4, 8, 12], "idxmax": 9, "idxmin": 9, "illustr": 3, "implement": [0, 1, 5, 10], "import": [1, 3, 4, 9, 12], "includ": 9, "incorpor": 1, "inform": [6, 8], "infrastructur": 6, "inherit": [3, 9, 12], "initi": [3, 4, 8], "initial_sampling_method": [1, 4, 9], "initialization_paramet": [3, 8], "inject": 3, "input": [1, 3, 4, 5, 12], "input_paramet": [1, 12], "inputs_df": 9, "insid": [1, 3, 4, 8, 12], "insight": 9, "instal": [0, 2, 5], "instanc": [4, 9], "instruct": 4, "instrument": 12, "int": [3, 9, 12], "integ": [1, 5], "integr": 1, "intellig": 9, "intens": 8, "interact": 1, "interfac": [8, 12], "invok": 6, "involv": 1, "ip": 8, "isol": 6, "iter": 9, "iterrow": 9, "its": [3, 4, 6, 8, 12], "itself": 2, "j": 8, "jinja2": [0, 5], "kcl": 12, "kei": [1, 3, 4, 9, 12], "keyword": 4, "kind": 12, "known_subst": 12, "lab": [0, 1, 3, 4, 7, 8, 10, 12], "lab_id": 4, "laboratori": [0, 1, 3, 5, 6, 9, 10, 12], "larg": 1, "launch": 10, "layer": [8, 9], "learn": 1, "leav": 1, "left": 4, "length": 12, "let": [1, 3, 4, 12], "letter": 7, "level": [1, 3, 10], "linux": 6, "list": [5, 8, 9], "load": [3, 7, 10], "loc": 9, "locat": [5, 7, 10], "long": 12, "look": [1, 4], "lookup": 12, "loop": [1, 7], "loss": [1, 4, 9], "low": 10, "lower": 3, "lower_bound": 9, "mac": 6, "made": 12, "magenta_volum": [1, 4, 9], "magnet": [3, 4, 12], "magnetic_mix": [3, 4, 12], "magneticmixerdevic": 3, "magneticmixingtask": 12, "mai": [1, 4, 10, 12], "make": [5, 6, 9, 12], "manag": [1, 3, 4, 6, 12], "mani": 1, "manipul": [3, 8], "manual": 12, "manufactur": 10, "map": 8, "map_coordin": 8, "match": 8, "materi": 8, "max": 12, "max_temperatur": 8, "maxim": 9, "maximum": 12, "mean": [9, 12], "measur": 8, "meet": 12, "metadata": [3, 7, 8], "metal": 8, "method": 9, "metric": 9, "min": 12, "minim": [1, 9], "minimizeobject": [1, 4, 9], "minimum": 12, "minio": [2, 6, 12], "mix": [1, 3, 4, 9, 12], "mix_color": [1, 4, 9], "mixer": [3, 4, 12], "mixing_spe": [1, 3, 4, 9, 12], "mixing_tim": [1, 3, 4, 9, 12], "ml": 8, "mlp": 9, "mm": 12, "mobil": [3, 8], "mobile_robot": 8, "model": 9, "modul": [1, 3, 9], "moment": 3, "mongodb": [2, 6], "more": [0, 1, 3, 4, 6, 8, 9, 12], "most": [3, 9], "move": [4, 12], "move_container_to_analyz": 4, "move_container_to_mix": 4, "multi": 9, "multipl": [0, 1, 3, 8, 12], "must": [1, 3, 4, 6, 8, 9, 12], "my_packag": 10, "n": [1, 12], "nacl": 12, "name": [3, 4, 5, 8, 12], "nativ": 1, "navig": 6, "necessari": [1, 3, 9], "need": [1, 2, 3, 8, 9], "network": 6, "new": 10, "next": [1, 4], "nitrogen": 8, "node": 4, "none": [3, 9, 12], "now": [4, 6], "num_experi": 9, "num_initial_sampl": [1, 4, 9], "number": 12, "object": [1, 4, 6, 9, 12], "objectivetyp": 9, "offer": 9, "often": 3, "one": [0, 3, 4, 8, 9, 12], "onli": [1, 4, 10, 12], "open_connect": 3, "oper": [1, 3, 12], "optim": [0, 5], "optimal_solut": 9, "optimize_yield": 4, "option": [4, 5, 6, 12], "orchestr": [5, 8, 9], "order": [4, 12], "org": 6, "organ": 10, "origin": 12, "other": [4, 6, 8], "our": [4, 6], "out": 8, "output": [0, 1, 4, 5, 12], "output_contain": 4, "output_paramet": [1, 12], "outputs_df": 9, "outputtyp": 12, "over": [1, 9], "overridden": [3, 8], "own": [3, 4, 6, 8, 12], "ozon": 8, "packag": [0, 3, 4, 5, 8, 9, 12], "pair": 12, "panda": 9, "paradigm": 1, "param": 9, "paramet": [0, 1, 2, 3, 4, 5, 8], "parameter_nam": 9, "parameterstyp": 12, "part": 4, "pass": [4, 12], "pd": 9, "pdm": 5, "peak": 12, "per": [3, 4, 12], "perceptron": 9, "perform": [6, 8, 12], "perovskit": 8, "persist": 3, "petri_dish": 8, "ph": 12, "phase": 5, "phenyl": 12, "physic": [3, 8], "pkg": 10, "place": [8, 10], "plan": 12, "plugin": 0, "port": 3, "portion": 7, "possibl": [1, 4, 9, 12], "power": 9, "preced": 4, "precursor_vial_1": 8, "precursor_vial_2": 8, "precursor_vial_3": 8, "predefin": 12, "prefix": 12, "prepar": 8, "prevent": 0, "previou": [1, 9], "problem": [1, 9], "process": [3, 8, 9], "project": 6, "provid": [0, 2, 3, 4, 6], "py": [1, 5, 6, 9, 12], "python": [5, 7, 10], "python3": 6, "qnei": [1, 4, 9], "rai": [0, 8, 9, 12], "random": [4, 9], "randomli": 9, "randomsamplingoptim": 9, "rang": 9, "raw": 12, "read": 2, "readm": 10, "reason": 6, "recommend": 6, "record": [3, 12], "red": [1, 4], "refer": [4, 8, 9, 12], "referenc": 12, "reinforc": 1, "rememb": 3, "repeat": 4, "report": [9, 12], "repositori": [5, 10], "repres": [1, 3, 4, 12], "requir": [1, 3, 4, 5, 6, 12], "resourc": [0, 3, 10], "rest": 5, "result": [0, 3, 9], "retriev": 4, "retrieve_contain": 4, "return": [1, 3, 4, 9, 12], "reus": [0, 10], "rgb": 4, "rins": 4, "robot": [1, 3, 4, 8], "robot_arm": 4, "robot_comput": 8, "room": 8, "root": 10, "row": 9, "run": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 12], "runtim": [0, 7, 10, 12], "same": [3, 7, 8, 9], "sampl": [0, 3, 8, 9, 12], "sample_r": 12, "samplingmethodenum": [1, 4, 9], "schedul": 0, "score": [1, 4], "score_color": [1, 4, 9], "script": 10, "sdl": 0, "search": 1, "second": 12, "section": [1, 4, 8, 12], "secur": 6, "see": [1, 4, 6], "select": 1, "self": [0, 1, 3, 9, 12], "send": 3, "send_command": 3, "sequenc": [1, 12], "sequenti": 9, "sequential_bayesian_optim": [1, 4, 9], "seri": [4, 12], "serial": 3, "serv": 0, "server": [3, 6], "servic": [5, 6], "set": [1, 3, 4, 6, 12], "set_spe": 3, "set_tim": 3, "setup": [5, 6], "sever": [1, 9], "share": [0, 10], "shortcut": 10, "should": [1, 3, 6], "shown": 4, "signal": 12, "simpl": 10, "simpli": 9, "simul": 8, "singl": 9, "six": 1, "so": 7, "sobol": [1, 4, 9], "softwar": 0, "solar": 8, "solar_cell_fabrication_lab": 8, "solar_sim_comput": 8, "solar_simul": 8, "solut": [4, 8, 12], "solvent": 8, "some": [1, 3, 4, 7, 12], "sourc": 5, "space": 8, "spec": 12, "special": 4, "specif": [1, 4, 5, 8, 10], "specifi": [3, 4, 8, 12], "spectrum": 8, "speed": [1, 3], "spin": 8, "spin_coat": 8, "sri": 12, "sri_gas_chromatograph": 12, "ssl": 6, "standalon": 1, "start": [3, 8], "state": [1, 3], "static": [0, 12], "station": [4, 8], "statu": 3, "step": 1, "still": 12, "stop": 3, "storag": [0, 4, 6, 12], "storage_loc": 4, "store": [4, 12], "store_contain": 4, "str": [3, 9, 12], "string": 5, "strongli": 6, "structur": [8, 12], "subdirectori": [3, 4, 8, 10, 12], "subfold": [3, 4, 8, 12], "substanc": 12, "substrat": 8, "substrate_dish_1": 8, "substrate_dish_2": 8, "summar": 1, "support": [1, 7, 9, 12], "surrog": 9, "synthes": [1, 4], "syring": 3, "system": [4, 8], "t": 10, "take": [1, 4, 8, 12], "target_loc": 4, "task": [0, 1, 3, 4, 5, 7, 8, 9, 10], "temperatur": 12, "templat": [0, 5], "termin": [3, 12], "test": [5, 8], "text": 12, "than": 9, "thei": [1, 4, 8, 9, 12], "them": [1, 4, 12], "thermal": 8, "thermal_evapor": 8, "theta": 8, "thi": [1, 3, 4, 7, 8, 9, 10, 12], "thought": [8, 12], "three": 12, "threshold": 12, "threshold_voltag": 12, "through": [1, 3, 4, 12], "throughout": 3, "time": [1, 3, 9], "to_dict": 9, "togeth": [1, 8], "total": 1, "transfer": [1, 8], "transport": 8, "treat": 12, "treatment": 8, "tree": 10, "tri": 12, "true": 12, "try": 1, "tupl": [1, 4, 9], "two": [3, 4, 12], "type": [1, 3, 4, 7, 8, 9, 12], "ui": 6, "undefin": 4, "under": [9, 10], "uniform": 9, "uniqu": [8, 12], "unit": [1, 12], "unknown_subst": 12, "unless": 8, "up": [1, 3, 6, 11], "updat": 3, "upper_bound": 9, "uri": 6, "us": [0, 1, 3, 4, 6, 7, 8, 9, 10, 12], "usebasicpars": 6, "user": [1, 3, 4, 10, 12], "usual": [1, 3], "uv": 8, "uv_ozone_clean": 8, "v": 8, "valid": [0, 12], "valu": [2, 4, 9, 12], "variabl": 7, "variou": [3, 9, 10], "vessel": [8, 12], "via": [3, 12], "vial": [8, 12], "vial_2ml": 12, "virtual": [3, 5], "volt": 12, "voltag": 12, "volum": [1, 4], "w": [1, 4, 9], "walk": [3, 12], "water": 4, "we": [1, 2, 3, 4, 6, 9], "web": 6, "webrequest": 6, "well": [1, 2], "when": [3, 4], "where": [4, 6, 8, 9], "whether": 12, "which": [1, 3, 4, 8, 10, 12], "while": 10, "window": 6, "wish": 6, "worker": 9, "would": 4, "wrapper": 12, "x": 8, "xrd": 8, "xrd_comput": 8, "xrd_system": 8, "y": 8, "yaml": [2, 5, 7, 8], "yellow_volum": [1, 4, 9], "yml": [1, 2, 5, 7, 8, 9], "you": [2, 6, 8, 10]}, "titles": ["The Experiment Orchestration System (EOS)", "Campaigns", "Configuration", "Devices", "Experiments", "User Guide", "Installation", "Jinja2 Templating", "Laboratories", "Optimizers", "Packages", "Running", "Tasks"], "titleterms": {"1": [2, 6, 11], "2": [2, 6, 11], "3": [6, 11], "4": 11, "The": 0, "advanc": 5, "analyz": 1, "api": 11, "autom": 1, "boolean": 12, "campaign": 1, "choic": 12, "clone": 6, "comput": 8, "concept": 5, "configur": 2, "contain": [8, 12], "creat": 10, "custom": 9, "decim": 12, "depend": 6, "design": 1, "devic": [3, 8], "dictionari": 12, "distribut": 9, "environ": 11, "eo": [0, 2, 6, 11], "exampl": 9, "execut": 9, "experi": [0, 4], "extern": [2, 11], "file": [3, 4, 12], "get": 5, "guid": [0, 5], "implement": [3, 4, 8, 9, 12], "input": 9, "instal": 6, "integ": 12, "jinja2": 7, "laboratori": 8, "list": 12, "locat": 8, "make": 1, "name": 9, "optim": [1, 4, 9], "option": 8, "orchestr": [0, 11], "output": 9, "packag": 10, "paramet": [9, 12], "pdm": 6, "phase": 1, "py": [3, 4], "python": [3, 12], "repositori": 6, "requir": 8, "rest": 11, "run": 11, "servic": [2, 11], "setup": 1, "sourc": 11, "specif": 12, "start": [5, 11], "string": 12, "system": 0, "task": 12, "templat": 7, "test": 1, "user": [0, 5], "virtual": 11, "yaml": [3, 4, 12], "yml": [3, 4, 12]}}) \ No newline at end of file +Search.setIndex({"alltitles": {"1. Configure External Services": [[2, "configure-external-services"]], "1. Install PDM": [[6, "install-pdm"]], "1. Start External Services": [[11, "start-external-services"]], "2. Clone the EOS Repository": [[6, "clone-the-eos-repository"]], "2. Configure EOS": [[2, "configure-eos"]], "2. Source the Virtual Environment": [[11, "source-the-virtual-environment"]], "3. Install Dependencies": [[6, "install-dependencies"]], "3. Start the EOS Orchestrator": [[11, "start-the-eos-orchestrator"]], "4. Start the EOS REST API": [[11, "start-the-eos-rest-api"]], "Advanced": [[5, null]], "Automation Setup (Make and Test Phases)": [[1, "automation-setup-make-and-test-phases"]], "Boolean": [[12, "boolean"]], "Campaigns": [[1, null]], "Choice": [[12, "choice"]], "Computers (Optional)": [[8, "computers-optional"]], "Concepts": [[5, null]], "Configuration": [[2, null]], "Containers": [[12, "containers"]], "Containers (Optional)": [[8, "containers-optional"]], "Create a Package": [[10, "create-a-package"]], "Decimal": [[12, "decimal"]], "Device Implementation": [[3, "device-implementation"]], "Devices": [[3, null]], "Devices (Required)": [[8, "devices-required"]], "Dictionary": [[12, "dictionary"]], "Distributed Execution": [[9, "distributed-execution"]], "Example Custom Optimizer": [[9, "example-custom-optimizer"]], "Experiment Implementation": [[4, "experiment-implementation"]], "Experiments": [[4, null]], "Files": [[12, "files"]], "Getting Started": [[5, null]], "Input and Output Parameter Naming": [[9, "input-and-output-parameter-naming"]], "Installation": [[6, null]], "Integer": [[12, "integer"]], "Jinja2 Templating": [[7, null]], "Laboratories": [[8, null]], "Laboratory Implementation": [[8, "laboratory-implementation"]], "List": [[12, "list"]], "Locations (Optional)": [[8, "locations-optional"]], "Optimization Setup (Analyze and Design Phases)": [[1, "optimization-setup-analyze-and-design-phases"]], "Optimizer File (optimizer.py)": [[4, "optimizer-file-optimizer-py"]], "Optimizer Implementation": [[9, "optimizer-implementation"]], "Optimizers": [[9, null]], "Packages": [[10, null]], "Parameter Specification": [[12, "parameter-specification"]], "Parameters": [[12, "parameters"]], "Python File (device.py)": [[3, "python-file-device-py"]], "Python File (task.yml)": [[12, "python-file-task-yml"]], "Running": [[11, null]], "String": [[12, "string"]], "Task Implementation": [[12, "task-implementation"]], "Tasks": [[12, null]], "The Experiment Orchestration System (EOS)": [[0, null]], "User Guide": [[0, null], [5, null]], "YAML File (device.yml)": [[3, "yaml-file-device-yml"]], "YAML File (experiment.yml)": [[4, "yaml-file-experiment-yml"]], "YAML File (task.yml)": [[12, "yaml-file-task-yml"]]}, "docnames": ["index", "user-guide/campaigns", "user-guide/configuration", "user-guide/devices", "user-guide/experiments", "user-guide/index", "user-guide/installation", "user-guide/jinja2_templating", "user-guide/laboratories", "user-guide/optimizers", "user-guide/packages", "user-guide/running", "user-guide/tasks"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "user-guide/campaigns.rst", "user-guide/configuration.rst", "user-guide/devices.rst", "user-guide/experiments.rst", "user-guide/index.rst", "user-guide/installation.rst", "user-guide/jinja2_templating.rst", "user-guide/laboratories.rst", "user-guide/optimizers.rst", "user-guide/packages.rst", "user-guide/running.rst", "user-guide/tasks.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [1, 3, 4, 12], "0": [1, 4, 8, 9, 12], "1": [1, 4, 5, 8, 9, 12], "10": [1, 4, 8, 9], "100": 8, "1000c": 8, "100mw": 8, "101": 8, "102": 8, "103": 8, "127": 8, "15": [1, 4, 9], "150": 12, "168": 8, "192": 8, "192000": 12, "2": [5, 9, 12], "20": 8, "25": 12, "3": 5, "300": 7, "4": [5, 12], "44100": 12, "480": 12, "5": [1, 4, 8, 9, 12], "50": [1, 4, 9, 12], "500": [1, 4, 9], "5004": 3, "5g": 8, "7": 12, "8": 12, "8000": 12, "A": [0, 1, 3, 8, 12], "As": 4, "But": 3, "By": 10, "For": [1, 3, 4, 10], "If": [1, 4, 6, 8], "In": [1, 3, 4, 9, 12], "It": [1, 9, 10, 12], "No": 8, "One": 9, "The": [1, 3, 4, 7, 8, 9, 12], "Then": 3, "There": [1, 3, 4, 8, 12], "These": [8, 10], "_": 9, "__init__": 9, "_cleanup": 3, "_execut": 12, "_initi": 3, "_report": 3, "abl": 9, "about": [1, 8], "abov": [3, 4], "abstract": 3, "abstract_sequential_optim": [1, 4, 9], "abstractsequentialoptim": [1, 4, 9], "accept": 12, "access": 6, "achiev": 9, "acquisit": 9, "acquisition_funct": [1, 4, 9], "across": [0, 4, 10, 12], "act": 12, "activ": [9, 11], "actor": [9, 12], "acycl": 4, "addit": [1, 4, 8, 10, 12], "address": 8, "adjac": [1, 9], "after": 2, "ag": 8, "ag_cruc": 8, "aggreg": 0, "ai": 3, "al": 8, "algorithm": 1, "all": [1, 2, 3, 4, 6, 8, 9, 10, 12], "alloc": 0, "allow": [1, 7, 8, 10], "along": 9, "also": [1, 3, 4, 6, 9, 10, 12], "alwai": [3, 8], "am1": 8, "amino": 12, "an": [1, 3, 4, 8, 9, 10, 12], "analysi": [8, 12], "analysis_tim": 12, "analyz": [4, 5], "analyze_color": 4, "ani": [1, 3, 4, 8, 9, 12], "anneal": 8, "annealing_st": 8, "anoth": [1, 10], "anyth": 3, "api": 5, "apparatu": 3, "apparatus": 8, "append": 9, "ar": [1, 2, 3, 4, 7, 8, 9, 10, 12], "area": 12, "argument": [4, 9, 12], "arm": [1, 4], "around": 8, "assign": 12, "associ": 9, "au": 8, "au_cruc": 8, "author": 7, "authorit": 0, "auto": 12, "auto_calibr": 12, "autom": [0, 3, 5, 6, 8], "automat": 0, "autonom": [1, 9], "avail": 4, "axi": 9, "b": [1, 7], "back": 4, "base": [1, 4, 9, 12], "base_devic": 3, "base_task": 12, "basedevic": 3, "basetask": 12, "batch": 8, "bayesian": [0, 1, 9], "bayesiansequentialoptim": [1, 4, 9], "beaker": [4, 7, 12], "beaker_500ml": 12, "befor": [4, 12], "below": [3, 4, 7, 8, 9, 10, 12], "between": [1, 4], "bi": 6, "bin": 11, "black": 9, "black_volum": [1, 4, 9], "block": 12, "blue": [1, 4], "bofir": [1, 4, 9], "bool": 12, "boolean": 5, "both": [1, 3, 9], "botorch": 9, "bound": [1, 4, 9], "box": 9, "branch": 1, "budibas": 6, "buffer": 12, "buffer_composit": 12, "build": [6, 9, 12], "built": [0, 1, 9], "c": 7, "c18": 12, "c8": 12, "c_": 7, "c_a": 4, "c_b": 4, "c_c": 4, "c_d": 4, "c_e": 4, "cacl2": 12, "calibr": 12, "call": [1, 3, 4, 8, 10, 12], "campaign": [0, 4, 5, 8, 9], "can": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12], "cannot": 12, "capabl": [6, 8, 9], "capac": [7, 8], "care": 1, "case": [3, 12], "cd": 11, "cell": 8, "central": [0, 6, 8], "chamber": 8, "channel": 12, "channel_gain": 12, "charact": 12, "character": 8, "characterization_room": 8, "choic": 5, "chosen": 4, "chromatographi": [3, 12], "class": [3, 4, 9, 12], "clean": [3, 4], "clean_contain": 4, "cleaner": 8, "cleaning_st": 4, "clear": 12, "client": [3, 10], "clone": 5, "close": 1, "close_connect": 3, "cm2": 8, "cmyk": [1, 4], "coat": 8, "coater": 8, "code": [0, 3, 10, 12], "collect": 8, "color": [1, 4, 9], "color_analyz": 4, "color_dispens": 4, "color_lab": [3, 4, 8, 10], "color_mix": [4, 10], "column": [9, 12], "column_typ": 12, "com": 6, "command": [3, 10], "common": [0, 1, 3, 9, 10], "commun": [0, 3, 10], "compar": 1, "compat": 12, "complex": 7, "compon": 1, "compos": [1, 2, 6, 11], "composit": 12, "comprehens": 0, "comput": [5, 6, 9], "concat": 9, "concentr": 12, "condit": 7, "config": 2, "configur": [0, 5], "conflict": 0, "connect": [3, 6, 8], "constrain": 9, "constraint": [1, 4, 9, 12], "constructor": [4, 9], "constructor_arg": [1, 4, 9], "contain": [0, 1, 3, 4, 5, 7, 9, 10], "container_storag": [4, 7], "containerstyp": 12, "content": [3, 6], "continu": [1, 4, 9], "continuousinput": [1, 4, 9], "continuousoutput": [1, 4, 9], "contract": 12, "contribut": 6, "control": [0, 8], "coordin": 8, "copi": 2, "correct": 12, "could": [3, 4, 12], "cp": 2, "creat": [1, 3, 5, 9, 12], "credenti": 2, "crucibl": 8, "crystal": 8, "curl": 6, "current": 12, "curv": 8, "custom": [1, 5], "cyan_volum": [1, 4, 9], "d": [7, 11], "dag": 4, "data": [3, 8, 10, 12], "data_model": [1, 4, 9], "databas": 6, "dataclass": 9, "datafram": 9, "decim": [1, 5], "dedic": [3, 9], "def": [1, 3, 4, 9, 12], "default": [10, 12], "defin": [0, 4, 7, 8, 9, 12], "definit": [3, 10, 12], "delet": 10, "denot": 4, "depend": [1, 4, 5], "deposit": 8, "descript": [1, 3, 4, 8, 12], "design": [0, 5], "desir": 4, "detail": 3, "detect": 12, "determin": 3, "dev": 6, "develop": 6, "devic": [0, 1, 4, 5, 7, 10, 12], "device_cli": 3, "device_typ": 12, "devicecli": 3, "devicestyp": 12, "df": 9, "dict": [1, 3, 4, 9, 12], "dictionari": 5, "differ": [1, 4, 8, 9, 12], "diffractomet": 8, "direct": [4, 6], "directori": 10, "discov": [3, 10, 12], "dispens": 4, "dispense_color": [1, 4, 9], "dissect": 4, "distil": 4, "distribut": [0, 5], "dmta": 1, "doc": 6, "docker": [2, 6, 11], "document": [6, 12], "don": 10, "download": 12, "draw": 9, "drive": [0, 1], "driver": [3, 10], "dure": [7, 12], "dynam": [0, 1, 4, 12], "e": [3, 4, 7, 8, 12], "each": [1, 3, 4, 8, 9, 10, 12], "easier": [6, 7], "easili": 6, "edg": 4, "edit": 2, "either": 4, "electrod": 8, "element": 12, "element_typ": 12, "elementari": 12, "els": 9, "empti": 4, "empty_contain": 4, "emptying_loc": 4, "enabl": [7, 9], "encapsul": [1, 12], "end": [3, 12], "endfor": 7, "enforc": 12, "ensur": [1, 2, 6, 12], "entiti": 3, "enum": [1, 4, 9], "env": [2, 11], "environ": [2, 5], "eo": [1, 3, 4, 5, 7, 8, 9, 10, 12], "eos_comput": 8, "eos_create_campaign_optim": [1, 4, 9], "eos_dynam": [1, 4], "ephemer": 12, "equip": [8, 10], "equival": 12, "especi": 9, "essenti": [4, 10], "etc": 12, "evalu": [7, 9], "evapor": 8, "evaporation_chamb": 8, "even": 1, "everi": [3, 4, 8, 12], "exampl": [1, 2, 3, 4, 5, 8, 10, 12], "execut": [0, 1, 4, 5, 12], "exist": 8, "expect": [1, 10], "expens": 9, "experi": [1, 3, 5, 7, 8, 9, 10], "experiment": 1, "experiment_": 12, "express": 7, "extens": 0, "extern": [5, 12], "fabric": 8, "fals": 12, "featur": [1, 4, 9], "feedback": 3, "feeder": 4, "feel": 10, "field": 2, "figur": 3, "file": [0, 1, 2, 5, 6, 7, 8, 9, 10], "file_prefix": 12, "fill": 8, "find": 4, "first": 4, "five": 4, "float": [9, 12], "folder": 10, "follow": 12, "form": 4, "format": 9, "forward": 9, "found": [1, 4], "foundat": 0, "four": 4, "framework": 0, "free": 10, "from": [1, 2, 3, 4, 9, 10, 12], "fulli": 4, "fume": 8, "fume_hood": 8, "function": [1, 3, 4, 9, 12], "futur": 12, "g": [3, 4, 6, 8, 12], "ga": [3, 12], "gain": 12, "gaussian": 9, "gc": [3, 12], "gener": [4, 12], "get": 4, "get_all_by_typ": 12, "get_input_nam": 9, "get_optimal_solut": 9, "get_output_nam": 9, "git": 6, "github": 6, "give": 9, "given": [3, 12], "global": 12, "glovebox": 8, "go": 8, "goal": 1, "gp": 9, "graph": 4, "green": [1, 4], "group": 8, "guid": [4, 6], "guidelin": 1, "ha": [1, 3, 4, 6, 8, 9, 12], "have": [1, 8, 12], "here": 8, "hexyl": 12, "highest": 1, "hilic": 12, "hold": 8, "home": 12, "hood": 8, "host": 8, "hotplat": 8, "how": [1, 8, 12], "howev": [9, 12], "hplc": 12, "http": 6, "hz": 12, "i": [0, 1, 3, 4, 6, 7, 8, 9, 10, 12], "id": [4, 7, 8, 12], "ident": [1, 4, 9], "identifi": [4, 8, 12], "idxmax": 9, "idxmin": 9, "illustr": 3, "implement": [0, 1, 5, 10], "import": [1, 3, 4, 9, 12], "includ": 9, "incorpor": 1, "inform": [6, 8], "infrastructur": 6, "inherit": [3, 9, 12], "initi": [3, 4, 8], "initial_sampling_method": [1, 4, 9], "initialization_paramet": [3, 8], "inject": 3, "input": [1, 3, 4, 5, 12], "input_paramet": [1, 12], "inputs_df": 9, "insid": [1, 3, 4, 8, 12], "insight": 9, "instal": [0, 2, 5], "instanc": [4, 9], "instruct": 4, "instrument": 12, "int": [3, 9, 12], "integ": [1, 5], "integr": 1, "intellig": 9, "intens": 8, "interact": 1, "interfac": [8, 12], "invok": 6, "involv": 1, "ip": 8, "isol": 6, "iter": 9, "iterrow": 9, "its": [3, 4, 6, 8, 12], "itself": 2, "j": 8, "jinja2": [0, 5], "kcl": 12, "kei": [1, 3, 4, 9, 12], "keyword": 4, "kind": 12, "known_subst": 12, "lab": [0, 1, 3, 4, 7, 8, 10, 12], "lab_id": 4, "laboratori": [0, 1, 3, 5, 6, 9, 10, 12], "larg": 1, "launch": 10, "layer": [8, 9], "learn": 1, "leav": 1, "left": 4, "length": 12, "let": [1, 3, 4, 12], "letter": 7, "level": [1, 3, 10], "linux": 6, "list": [5, 8, 9], "load": [3, 7, 10], "loc": 9, "locat": [5, 7, 10], "long": 12, "look": [1, 4], "lookup": 12, "loop": [1, 7], "loss": [1, 4, 9], "low": 10, "lower": 3, "lower_bound": 9, "mac": 6, "made": 12, "magenta_volum": [1, 4, 9], "magnet": [3, 4, 12], "magnetic_mix": [3, 4, 12], "magneticmixerdevic": 3, "magneticmixingtask": 12, "mai": [1, 4, 10, 12], "make": [5, 6, 9, 12], "manag": [1, 3, 4, 6, 12], "mani": 1, "manipul": [3, 8], "manual": 12, "manufactur": 10, "map": 8, "map_coordin": 8, "match": 8, "materi": 8, "max": 12, "max_temperatur": 8, "maxim": 9, "maximum": 12, "mean": [9, 12], "measur": 8, "meet": 12, "metadata": [3, 7, 8], "metal": 8, "method": 9, "metric": 9, "min": 12, "minim": [1, 9], "minimizeobject": [1, 4, 9], "minimum": 12, "minio": [2, 6, 12], "mix": [1, 3, 4, 9, 12], "mix_color": [1, 4, 9], "mixer": [3, 4, 12], "mixing_spe": [1, 3, 4, 9, 12], "mixing_tim": [1, 3, 4, 9, 12], "ml": 8, "mlp": 9, "mm": 12, "mobil": [3, 8], "mobile_robot": 8, "model": 9, "modul": [1, 3, 9], "moment": 3, "mongodb": [2, 6], "more": [0, 1, 3, 4, 6, 8, 9, 12], "most": [3, 9], "move": [4, 12], "move_container_to_analyz": 4, "move_container_to_mix": 4, "multi": 9, "multipl": [0, 1, 3, 8, 12], "must": [1, 3, 4, 6, 8, 9, 12], "my_packag": 10, "n": [1, 12], "nacl": 12, "name": [3, 4, 5, 8, 12], "nativ": 1, "navig": 6, "necessari": [1, 3, 9], "need": [1, 2, 3, 8, 9], "network": 6, "new": 10, "next": [1, 4], "nitrogen": 8, "node": 4, "none": [3, 9, 12], "now": [4, 6], "num_experi": 9, "num_initial_sampl": [1, 4, 9], "number": 12, "object": [1, 4, 6, 9, 12], "objectivetyp": 9, "offer": 9, "often": 3, "one": [0, 3, 4, 8, 9, 12], "onli": [1, 4, 10, 12], "open_connect": 3, "oper": [1, 3, 12], "optim": [0, 5], "optimal_solut": 9, "optimize_yield": 4, "option": [4, 5, 6, 12], "orchestr": [5, 8, 9], "order": [4, 12], "org": 6, "organ": 10, "origin": 12, "other": [4, 6, 8], "our": [4, 6], "out": 8, "output": [0, 1, 4, 5, 12], "output_contain": 4, "output_paramet": [1, 12], "outputs_df": 9, "outputtyp": 12, "over": [1, 9], "overridden": [3, 8], "own": [3, 4, 6, 8, 12], "ozon": 8, "packag": [0, 3, 4, 5, 8, 9, 12], "pair": 12, "panda": 9, "paradigm": 1, "param": 9, "paramet": [0, 1, 2, 3, 4, 5, 8], "parameter_nam": 9, "parameterstyp": 12, "part": 4, "pass": [4, 12], "pd": 9, "pdm": 5, "peak": 12, "per": [3, 4, 12], "perceptron": 9, "perform": [6, 8, 12], "perovskit": 8, "persist": 3, "petri_dish": 8, "ph": 12, "phase": 5, "phenyl": 12, "physic": [3, 8], "pkg": 10, "place": [8, 10], "plan": 12, "plugin": 0, "port": 3, "portion": 7, "possibl": [1, 4, 9, 12], "power": 9, "preced": 4, "precursor_vial_1": 8, "precursor_vial_2": 8, "precursor_vial_3": 8, "predefin": 12, "prefix": 12, "prepar": 8, "prevent": 0, "previou": [1, 9], "problem": [1, 9], "process": [3, 8, 9], "project": 6, "provid": [0, 2, 3, 4, 6], "py": [1, 5, 6, 9, 12], "python": [5, 7, 10], "python3": 6, "qnei": [1, 4, 9], "rai": [0, 8, 9, 12], "random": [4, 9], "randomli": 9, "randomsamplingoptim": 9, "rang": 9, "raw": 12, "read": 2, "readm": 10, "reason": 6, "recommend": 6, "record": [3, 12], "red": [1, 4], "refer": [4, 8, 9, 12], "referenc": 12, "reinforc": 1, "rememb": 3, "repeat": 4, "report": [9, 12], "repositori": [5, 10], "repres": [1, 3, 4, 12], "requir": [1, 3, 4, 5, 6, 12], "resourc": [0, 3, 10], "rest": 5, "result": [0, 3, 9], "retriev": 4, "retrieve_contain": 4, "return": [1, 3, 4, 9, 12], "reus": [0, 10], "rgb": 4, "rins": 4, "robot": [1, 3, 4, 6, 8], "robot_arm": 4, "robot_comput": 8, "room": 8, "root": 10, "row": 9, "run": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 12], "runtim": [0, 7, 10, 12], "same": [3, 7, 8, 9], "sampl": [0, 3, 8, 9, 12], "sample_r": 12, "samplingmethodenum": [1, 4, 9], "schedul": 0, "score": [1, 4], "score_color": [1, 4, 9], "script": 10, "sdl": 0, "search": 1, "second": 12, "section": [1, 4, 8, 12], "secur": 6, "see": [1, 4, 6], "select": 1, "self": [0, 1, 3, 9, 12], "send": 3, "send_command": 3, "sequenc": [1, 12], "sequenti": 9, "sequential_bayesian_optim": [1, 4, 9], "seri": [4, 12], "serial": 3, "serv": 0, "server": [3, 6], "servic": [5, 6], "set": [1, 3, 4, 6, 12], "set_spe": 3, "set_tim": 3, "setup": [5, 6], "sever": [1, 9], "share": [0, 10], "shortcut": 10, "should": [1, 3, 6], "shown": 4, "signal": 12, "simpl": 10, "simpli": 9, "simul": 8, "singl": 9, "six": 1, "so": 7, "sobol": [1, 4, 9], "softwar": 0, "solar": 8, "solar_cell_fabrication_lab": 8, "solar_sim_comput": 8, "solar_simul": 8, "solut": [4, 8, 12], "solvent": 8, "some": [1, 3, 4, 7, 12], "sourc": 5, "space": 8, "spec": 12, "special": 4, "specif": [1, 4, 5, 8, 10], "specifi": [3, 4, 8, 12], "spectrum": 8, "speed": [1, 3], "spin": 8, "spin_coat": 8, "sri": 12, "sri_gas_chromatograph": 12, "ssl": 6, "standalon": 1, "start": [3, 8], "state": [1, 3], "static": [0, 12], "station": [4, 8], "statu": 3, "step": 1, "still": 12, "stop": 3, "storag": [0, 4, 6, 12], "storage_loc": 4, "store": [4, 12], "store_contain": 4, "str": [3, 9, 12], "string": 5, "strongli": 6, "structur": [8, 12], "subdirectori": [3, 4, 8, 10, 12], "subfold": [3, 4, 8, 12], "substanc": 12, "substrat": 8, "substrate_dish_1": 8, "substrate_dish_2": 8, "summar": 1, "support": [1, 7, 9, 12], "surrog": 9, "synthes": [1, 4], "syring": 3, "system": [4, 8], "t": 10, "take": [1, 4, 8, 12], "target_loc": 4, "task": [0, 1, 3, 4, 5, 7, 8, 9, 10], "temperatur": 12, "templat": [0, 5], "termin": [3, 12], "test": [5, 8], "text": 12, "than": 9, "thei": [1, 4, 8, 9, 12], "them": [1, 4, 12], "thermal": 8, "thermal_evapor": 8, "theta": 8, "thi": [1, 3, 4, 7, 8, 9, 10, 12], "thought": [8, 12], "three": 12, "threshold": 12, "threshold_voltag": 12, "through": [1, 3, 4, 12], "throughout": 3, "time": [1, 3, 9], "to_dict": 9, "togeth": [1, 8], "total": 1, "transfer": [1, 8], "transport": 8, "treat": 12, "treatment": 8, "tree": 10, "tri": 12, "true": 12, "try": 1, "tupl": [1, 4, 9], "two": [3, 4, 12], "type": [1, 3, 4, 7, 8, 9, 12], "ui": 6, "unc": 6, "undefin": 4, "under": [9, 10], "uniform": 9, "uniqu": [8, 12], "unit": [1, 12], "unknown_subst": 12, "unless": 8, "up": [1, 3, 6, 11], "updat": 3, "upper_bound": 9, "uri": 6, "us": [0, 1, 3, 4, 6, 7, 8, 9, 10, 12], "usebasicpars": 6, "user": [1, 3, 4, 10, 12], "usual": [1, 3], "uv": 8, "uv_ozone_clean": 8, "v": 8, "valid": [0, 12], "valu": [2, 4, 9, 12], "variabl": 7, "variou": [3, 9, 10], "vessel": [8, 12], "via": [3, 12], "vial": [8, 12], "vial_2ml": 12, "virtual": [3, 5], "volt": 12, "voltag": 12, "volum": [1, 4], "w": [1, 4, 9], "walk": [3, 12], "water": 4, "we": [1, 2, 3, 4, 6, 9], "web": 6, "webrequest": 6, "well": [1, 2], "when": [3, 4], "where": [4, 6, 8, 9], "whether": 12, "which": [1, 3, 4, 8, 10, 12], "while": 10, "window": 6, "wish": 6, "worker": 9, "would": 4, "wrapper": 12, "x": 8, "xrd": 8, "xrd_comput": 8, "xrd_system": 8, "y": 8, "yaml": [2, 5, 7, 8], "yellow_volum": [1, 4, 9], "yml": [1, 2, 5, 7, 8, 9], "you": [2, 6, 8, 10]}, "titles": ["The Experiment Orchestration System (EOS)", "Campaigns", "Configuration", "Devices", "Experiments", "User Guide", "Installation", "Jinja2 Templating", "Laboratories", "Optimizers", "Packages", "Running", "Tasks"], "titleterms": {"1": [2, 6, 11], "2": [2, 6, 11], "3": [6, 11], "4": 11, "The": 0, "advanc": 5, "analyz": 1, "api": 11, "autom": 1, "boolean": 12, "campaign": 1, "choic": 12, "clone": 6, "comput": 8, "concept": 5, "configur": 2, "contain": [8, 12], "creat": 10, "custom": 9, "decim": 12, "depend": 6, "design": 1, "devic": [3, 8], "dictionari": 12, "distribut": 9, "environ": 11, "eo": [0, 2, 6, 11], "exampl": 9, "execut": 9, "experi": [0, 4], "extern": [2, 11], "file": [3, 4, 12], "get": 5, "guid": [0, 5], "implement": [3, 4, 8, 9, 12], "input": 9, "instal": 6, "integ": 12, "jinja2": 7, "laboratori": 8, "list": 12, "locat": 8, "make": 1, "name": 9, "optim": [1, 4, 9], "option": 8, "orchestr": [0, 11], "output": 9, "packag": 10, "paramet": [9, 12], "pdm": 6, "phase": 1, "py": [3, 4], "python": [3, 12], "repositori": 6, "requir": 8, "rest": 11, "run": 11, "servic": [2, 11], "setup": 1, "sourc": 11, "specif": 12, "start": [5, 11], "string": 12, "system": 0, "task": 12, "templat": 7, "test": 1, "user": [0, 5], "virtual": 11, "yaml": [3, 4, 12], "yml": [3, 4, 12]}}) \ No newline at end of file diff --git a/user-guide/installation.html b/user-guide/installation.html index 8bb4372..556d7b6 100644 --- a/user-guide/installation.html +++ b/user-guide/installation.html @@ -382,7 +382,7 @@

1. Install PDM

2. Clone the EOS Repository#

-
git clone https://github.com/aangelos28/eos
+
git clone https://github.com/UNC-Robotics/eos