{ "info": { "author": "Michael Mercier", "author_email": "michael.mercier@inria.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Programming Language :: Python :: 3", "Topic :: System :: Clustering" ], "description": "===============================\nPybatsim\n===============================\n\nPyBatsim helps you developing your own scheduler in python!\n\nThe library consists of two layers:\n\n1. The low level API `batsim.batsim` which handles the communication with the\n Batsim instance (example scheduler: `schedulers/fillerSched.py`).\n2. The high level API `batsim.sched` which contains an object oriented abstraction layer\n to provide a simpler API for accessing data from Batsim and filtering for\n jobs and resources (example scheduler: `schedulers/delayProfilesAsTasks.py`).\n\nCommands\n--------\n\nThe following commands are provided:\n\n*pybatsim*\n To launch schedulers\n\n*pybatsim-experiment*\n To launch experiments\n\n*pybatsim-postprocess-jobs*\n To manipulate the `out_jobs.csv` file based on data only available in the\n scheduler but not in Batsim.\n\nBatsim Version Compatibilities\n------------------------------\n\nAs there are different release paces between Batsim and Pybatsim versions, here is a list of compatibilities between the two projects:\n\n - `Batsim master branch`_ with `Pybatsim master branch`_ (development branches, may be unstable)\n - `Batsim v3_0_0`_ with `Pybatsim v3_0_0`_ (latest major release, stable)\n - `Batsim v2_0_0`_ with `Pybatsim batsim_2_0_compatible`_\n\nMoreover, all notable changes are listed in the `changelog `_.\n\nExamples\n--------\n\nStart a scheduler\n~~~~~~~~~~~~~~~~~\n\nSee the *schedulers* directory for the available built-in schedulers.\nA simple built-in scheduler instance can be executed by calling::\n\n pybatsim fillerSched\n \nThis command, however, requires an already running Batsim instance.\n\nThe parameter to `pybatsim` can also be a file outside of the project directory\nlike::\n\n pybatsim path/to/scheduler.py\n\nSchedulers of the higher level API (`batsim.sched`) can be executed in the same way::\n\n pybatsim delayProfilesAsTasks\n \nThis example scheduler will make use of dynamic jobs and convert delay jobs into tasks.\nNote that dynamic job submissions have to be enabled in your running Batsim instance to be able to use this scheduler.\n\nTo see all available starting options see also::\n\n pybatsim --help\n\nRun an experiment\n~~~~~~~~~~~~~~~~~\n \nTo run a complete experiment the experiment launcher can be used::\n\n pybatsim-experiment --verbose sample.expe.json\n \nPlease note that Batsim has to be installed and the environment has to be set-up for this command to succeed.\n\nFiles\n-----\n\n*launcher.py*\n This is the main entry point to launch things\n\n*launch_expe.py*\n Provide an easy way to launch a complete simulation.\n Just provide a file that looks like `sample.expe.json` to this script and it will launch Batsim and the scheduler with the right options.\n\n*sample.expe.json*\n See `launch_expe.json`\n\n*batsim/batsim.py*\n This class helps you communicate with the batsim server\n\n*batsim/sched/*\n High level scheduler API\n \n*batsim/tools/*\n Tools to start the schedulers or for working with the generated data\n\n*schedulers/*\n Contains all the schedulers. Schedulers name should follow this convention:\n `fooBar.py` contains the `FooBar` classname which has as an ancestor `batsim.batsim.BatsimScheduler`.\n\n*schedulers/fillerSched.py*\n A kind of first fit without topology scheduler\n\n*schedulers/easyBackfill.py*\n EASY backfilling where jobs are seen as rectangles\n\n*schedulers/delayProfilesAsTasks.py*\n A scheduler using the high level scheduler API to split big delay jobs into\n small tasks.\n\nInstallation\n------------\n\nYou can install, upgrade, uninstall PyBatsim with these commands::\n\n pip install [--user] pybatsim\n pip install [--user] --upgrade pybatsim\n pip uninstall pybatsim\n\nDocumentation\n-------------\n\nTo generate the html documentation use the setup target::\n\n ./setup.py doc\n\nTesting\n-------\n\nTo run the test experiments it is preferable to first enter in a nix shell specific for the pybatsim development with the following command::\n\n nix-shell https://github.com/oar-team/kapack/archive/master.tar.gz -A pybatsim_dev\n\nThen you can run tests with the setup target::\n\n ./setup.py test --batsim-bin=path/to/batsim/binary\n\n\n.. _Batsim master branch: https://gitlab.inria.fr/batsim/batsim/tree/master\n.. _Pybatsim master branch: https://gitlab.inria.fr/batsim/pybatsim/tree/master\n.. _Batsim v3_0_0: https://gitlab.inria.fr/batsim/batsim/tags/v3.0.0\n.. _Pybatsim v3_0_0: https://gitlab.inria.fr/batsim/pybatsim/tags/v3.0.0\n.. _Batsim v2_0_0: https://gitlab.inria.fr/batsim/batsim/tags/v2.0.0\n.. _Pybatsim batsim_2_0_compatible: https://gitlab.inria.fr/batsim/pybatsim/tags/batsim_2.0_compatible", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.inria.fr/batsim/pybatsim", "keywords": "Scheduler", "license": "LGPLv3", "maintainer": "", "maintainer_email": "", "name": "pybatsim", "package_url": "https://pypi.org/project/pybatsim/", "platform": "", "project_url": "https://pypi.org/project/pybatsim/", "project_urls": { "Homepage": "https://gitlab.inria.fr/batsim/pybatsim" }, "release_url": "https://pypi.org/project/pybatsim/3.1.0/", "requires_dist": null, "requires_python": "", "summary": "Python scheduler for Batsim", "version": "3.1.0" }, "last_serial": 4711623, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "82d13f1130e415096422e20b9940b111", "sha256": "248ae2bc844c411e0481854e779277a0266fab9f9627d7a0147bf8ed1eb5aebb" }, "downloads": -1, "filename": "pybatsim-1.0.tar.gz", "has_sig": false, "md5_digest": "82d13f1130e415096422e20b9940b111", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27386, "upload_time": "2017-04-20T09:07:48", "url": "https://files.pythonhosted.org/packages/33/2b/859b5a76d2d70df4054fad916e4c90083d892ae02f7580bd575f23482114/pybatsim-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "7b7d6147e99a61cfcdaed04f36a9c5b6", "sha256": "6f2a7355baf69dcdddcfa527336787a6ab5667889e99cd3b7a643af0c2e8f529" }, "downloads": -1, "filename": "pybatsim-1.1.tar.gz", "has_sig": false, "md5_digest": "7b7d6147e99a61cfcdaed04f36a9c5b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27511, "upload_time": "2017-05-30T09:37:53", "url": "https://files.pythonhosted.org/packages/58/4c/45b4c2d879ae45bcdd8af7813cda4ace0f73ea57a3f35c2bf046aa089763/pybatsim-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "ac41eeebd10b75e91bc84d84ca4e431c", "sha256": "f87f4f756b2d5ae6b259720033b6a560d298c43a934f45915996f86b4b11746e" }, "downloads": -1, "filename": "pybatsim-1.2.tar.gz", "has_sig": false, "md5_digest": "ac41eeebd10b75e91bc84d84ca4e431c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27535, "upload_time": "2017-08-18T15:49:42", "url": "https://files.pythonhosted.org/packages/4d/56/053621d252ff2294141bed6bd2f3ed3491f01cf5441311739911caea2306/pybatsim-1.2.tar.gz" } ], "2.0": [ { "comment_text": "", "digests": { "md5": "ebe8945d4b149914a64ded76ef32d8f9", "sha256": "1185e6c38676903fe230212f550f6a7ff3ab8670f074279a894071225924c951" }, "downloads": -1, "filename": "pybatsim-2.0.tar.gz", "has_sig": false, "md5_digest": "ebe8945d4b149914a64ded76ef32d8f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 65373, "upload_time": "2017-10-03T10:55:22", "url": "https://files.pythonhosted.org/packages/56/32/37c5c5fcd2c770b986e4ae05395004531176cb291e54a6f4ce0434b89e3d/pybatsim-2.0.tar.gz" } ], "2.1": [ { "comment_text": "", "digests": { "md5": "da52f9c6585f65f9ddfa46721339c71d", "sha256": "d58f12f29d0452a957d79cca78652dbda1240f527e9cfafb72a39fc2360ac6e1" }, "downloads": -1, "filename": "pybatsim-2.1.tar.gz", "has_sig": false, "md5_digest": "da52f9c6585f65f9ddfa46721339c71d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 88435, "upload_time": "2018-08-29T13:20:12", "url": "https://files.pythonhosted.org/packages/75/b9/a19f5b18349221185ade8c7b21f25800b3094f5d13f3af16d8c08c4ab220/pybatsim-2.1.tar.gz" } ], "2.1.1": [ { "comment_text": "", "digests": { "md5": "d91faa5c1c9e1362e47ae43c3a80c7f9", "sha256": "37b2ba138efb647a504d1cd89c4355d7941bc3cfba17b46a69f562579527952b" }, "downloads": -1, "filename": "pybatsim-2.1.1.tar.gz", "has_sig": false, "md5_digest": "d91faa5c1c9e1362e47ae43c3a80c7f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 88544, "upload_time": "2018-08-31T14:42:29", "url": "https://files.pythonhosted.org/packages/45/ee/5443df4cf25f780c40a48fafd4bfa94bf137e8390e4d5cee4f56a0d6b91d/pybatsim-2.1.1.tar.gz" } ], "3.0.0a0": [ { "comment_text": "", "digests": { "md5": "5a54e5ed737e36f268b05b97d9e37108", "sha256": "2921a43382f38c68c4edd7c82d138a661b6882d8d250fb002b04cfa3117b0a86" }, "downloads": -1, "filename": "pybatsim-3.0.0a0.tar.gz", "has_sig": false, "md5_digest": "5a54e5ed737e36f268b05b97d9e37108", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 95639, "upload_time": "2018-11-22T17:31:43", "url": "https://files.pythonhosted.org/packages/0c/7d/68188c3b3f64c467fdb48b6ea0afc3d00d842f447b0587bd8a59b71613d2/pybatsim-3.0.0a0.tar.gz" } ], "3.1.0": [ { "comment_text": "", "digests": { "md5": "0b913bafad07f39cf4cc95b10299051e", "sha256": "8f0b0cb034bb7f9882c0c77f814427888e72812c6e9110fcccf4fe30d0c4b836" }, "downloads": -1, "filename": "pybatsim-3.1.0.tar.gz", "has_sig": false, "md5_digest": "0b913bafad07f39cf4cc95b10299051e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 79338, "upload_time": "2019-01-18T10:03:25", "url": "https://files.pythonhosted.org/packages/9c/1b/8df68975f3226afd6b2ac48638edd5695b94429a5b89d710d054ece9cc75/pybatsim-3.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0b913bafad07f39cf4cc95b10299051e", "sha256": "8f0b0cb034bb7f9882c0c77f814427888e72812c6e9110fcccf4fe30d0c4b836" }, "downloads": -1, "filename": "pybatsim-3.1.0.tar.gz", "has_sig": false, "md5_digest": "0b913bafad07f39cf4cc95b10299051e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 79338, "upload_time": "2019-01-18T10:03:25", "url": "https://files.pythonhosted.org/packages/9c/1b/8df68975f3226afd6b2ac48638edd5695b94429a5b89d710d054ece9cc75/pybatsim-3.1.0.tar.gz" } ] }