{"id":18254282,"url":"https://github.com/realvnf/common-utils","last_synced_at":"2025-04-04T17:30:41.493Z","repository":{"id":54906838,"uuid":"194496730","full_name":"RealVNF/common-utils","owner":"RealVNF","description":"Interface definition between coordination algorithms and environments. Includes a dummy algorithm and environment as example.","archived":false,"fork":false,"pushed_at":"2021-03-19T17:45:29.000Z","size":92,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-06T04:17:51.072Z","etag":null,"topics":["algorithms","coordination","environment","interface","management","nfv","orchestration","python","simulation"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RealVNF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-30T09:10:34.000Z","updated_at":"2021-03-19T17:45:31.000Z","dependencies_parsed_at":"2022-08-14T06:20:16.774Z","dependency_job_id":null,"html_url":"https://github.com/RealVNF/common-utils","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealVNF%2Fcommon-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealVNF%2Fcommon-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealVNF%2Fcommon-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealVNF%2Fcommon-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RealVNF","download_url":"https://codeload.github.com/RealVNF/common-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223150742,"owners_count":17095959,"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":["algorithms","coordination","environment","interface","management","nfv","orchestration","python","simulation"],"created_at":"2024-11-05T10:11:27.169Z","updated_at":"2024-11-05T10:11:29.104Z","avatar_url":"https://github.com/RealVNF.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# common-utils\n\nInterface definition between coordination algorithms and environments. Includes a dummy environment as example.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/RealVNF/coord-sim/master/docs/realvnf_logo.png\" height=\"150\" hspace=\"30\"/\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/RealVNF/coord-sim/master/docs/upb.png\" width=\"200\" hspace=\"30\"/\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/RealVNF/coord-sim/master/docs/huawei_horizontal.png\" width=\"250\" hspace=\"30\"/\u003e\n\u003c/p\u003e\n\n## Project structure\n\n- `src/spinterface`: Interface definition between the scale and place algorithm and the environment.\n- `src/dummy-env`: Dummy environment/simulation implementation.\n\n## Interface definition\n\nThe main interface definition is described by the `SimulatorInterface` class.\n\nThe interface is guided by the gym interface (`gmy.Env`),\nThe `init()` aligns to the `reset()` function of gym and resets and\ninitializes the environment with all necessary information including a seed.\nThe `apply()` function reflects gym's `step()` method:\nIt sends a placement description for all nodes and\nsets the new routing/scheduling.\n\nTo pass the information, we utilizes two data classes:\n\n- `SimulatorAction` to pass the scaling and placement to the environment.\n- `simulatorState` to report back the current State of the environment.\n\n## Installation\n\nRequires [Python 3.6](https://www.python.org/downloads/release/) and (recommended) [venv](https://docs.python.org/3/library/venv.html).\n\n```bash\npython setup.py install\n```\n\n## Usage\n\n### Interface\n\nTo use the interface you need to use this module and import the needed classes:\n\n`from spinterface import SimulatorAction, SimulatorInterface, SimulatorState`\n\n### Dummy environment\n\nTo use the dummy environment use:\n\n`from dummy_env import DummySimulator as Simulator`\n\n## Acknowledgement\n\nThis project has received funding from German Federal Ministry of Education and Research ([BMBF](https://www.bmbf.de/)) through Software Campus grant 01IS17046 ([RealVNF](https://realvnf.github.io/)).\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/RealVNF/coord-sim/master/docs/software_campus.png\" width=\"200\"/\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/RealVNF/coord-sim/master/docs/BMBF_sponsored_by.jpg\" width=\"250\"/\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealvnf%2Fcommon-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frealvnf%2Fcommon-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealvnf%2Fcommon-utils/lists"}