{"id":22753615,"url":"https://github.com/slaclab/lume-epics","last_synced_at":"2025-04-14T15:30:58.086Z","repository":{"id":38076652,"uuid":"271842006","full_name":"slaclab/lume-epics","owner":"slaclab","description":"Lume-epics is a dedicated API for serving LUME model variables with EPICS.","archived":false,"fork":false,"pushed_at":"2023-06-30T00:32:57.000Z","size":1312,"stargazers_count":2,"open_issues_count":1,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-06T04:59:41.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://slaclab.github.io/lume-epics/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slaclab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-12T16:22:29.000Z","updated_at":"2023-11-15T20:35:38.000Z","dependencies_parsed_at":"2022-08-18T07:05:11.806Z","dependency_job_id":null,"html_url":"https://github.com/slaclab/lume-epics","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Flume-epics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Flume-epics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Flume-epics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Flume-epics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slaclab","download_url":"https://codeload.github.com/slaclab/lume-epics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248906392,"owners_count":21181171,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-11T06:12:11.109Z","updated_at":"2025-04-14T15:30:58.061Z","avatar_url":"https://github.com/slaclab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lume-epics\nLume-epics is a dedicated API for serving LUME model variables with EPICS. Configurations for LUME model variables can be found in [lume-model](https://github.com/slaclab/lume-model).\n\n# Installation\n\nLume-epics may be installed via conda on the `conda-forge` channel:\n\u003cbr\u003e\n``` $ conda install lume-epics -c conda-forge ```\n\u003cbr\u003e\n\n\nAlternatively, you may install from the GitHub repository using:\n\u003cbr\u003e\n``` $ pip install https://github.com/slaclab/lume-epics.git ```\n\u003cbr\u003e\n\n## Server\n\nThe EPICS server requires a model class, model_kwargs, and an epics configuration for instantiation. Once instantiated, the server is started using the `Server.start()` method, which has an optional monitor keyword argument, `monitor`, that controls thread execution. When `monitor=True`, the server is run in the main thread and may be stopped using keyboard interrupt (`Ctr+C`). If using `monitor=False`, the server can be stopped manually using the `Server.stop()` method.\n\n```python\nfrom lume_epics.epics_server import Server\nfrom lume_model.utils import variables_from_yaml\nfrom lume_epics.utils import config_from_yaml\nimport os\nfrom examples.model import DemoModel\n\nimport logging\n\n\nif __name__ == \"__main__\":\n    with open(\"examples/files/demo_config.yml\", \"r\") as f:\n        input_variables, output_variables = variables_from_yaml(f)\n\n    with open(\"examples/files/epics_config.yml\", \"r\") as f:\n        epics_config = config_from_yaml(f)\n\n    server = Server(\n        DemoModel,\n        epics_config,\n        model_kwargs={\n            \"input_variables\": input_variables,\n            \"output_variables\": output_variables,\n        },\n    )\n    # monitor = False does not loop in main thread\n    server.start(monitor=True)\n```\n\n## Compatable models\nSee docs for notes on serving online models with lume-epics.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Flume-epics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslaclab%2Flume-epics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Flume-epics/lists"}