{
    "info": {
        "author": "The vivarium developers",
        "author_email": "vivarium.dev@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "Vivarium Cluster Tools\n=======================\n\n.. image:: https://badge.fury.io/py/vivarium-cluster-tools.svg\n    :target: https://badge.fury.io/py/vivarium-cluster-tools\n\n.. image:: https://travis-ci.org/ihmeuw/vivarium_cluster_tools.svg?branch=master\n    :target: https://travis-ci.org/ihmeuw/vivarium_cluster_tools\n    :alt: Latest Version\n\n.. image:: https://readthedocs.org/projects/vivarium-cluster-tools/badge/?version=latest\n    :target: https://vivarium-cluster-tools.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\nVivarium cluster tools is a python package that makes running ``vivarium``\nsimulations at scale on a Univa Grid Engine cluster easy.\n\nInstallation\n------------\n\nYou can install this package with\n\n.. code-block:: console\n\n    pip install vivarium-cluster-tools\n\nIn addition, this tool needs the redis client. This must be installed using conda.\n\n.. code-block:: console\n\n    conda install redis\n\nA simple example\n----------------\n\nIf you have a ``vivarium`` model specifcation file defining a particular model,\nyou can use that along side a **branches file** to launch a run of many\nsimulations at once with variations in the input data, random seed, or with\ndifferent parameter settings.\n\n.. code-block:: console\n\n    psimulate run /path/to/model_specification.yaml /path/to/branches_file.yaml\n\nThe simplest branches file defines a count of input data draws and random seeds\nto launch.\n\n.. code-block:: yaml\n\n    input_draw_count: 25\n    random_seed_count: 10\n\n\nThis branches file defines a set of simulations for all combinations of 25\ninput draws and 10 random seeds and so would run, in total, 250 simulations.\n\nYou can also define a set of parameter variations to run your model over. Say\nyour original model specification looked something like\n\n.. code-block:: yaml\n\n    plugins:\n      optional: ...\n\n    components:\n      vivarium_public_health:\n        population:\n          - BasePopulation()\n          - Mortality()\n        disease.models:\n          - SIS('lower_respiratory_infections')\n      my_lri_intervention:\n        components:\n          - GiveKidsVaccines()\n\n    configuration:\n      population:\n        population_size: 1000\n        age_start: 0\n        age_end: 5\n      lri_vaccine:\n        coverage: 0.2\n        efficacy: 0.8\n\nDefining a simple model of lower respiratory infections and a vaccine\nintervention. You could then write a branches file that varied over both\ninput data draws and random seeds, but also over different levels of coverage\nand efficacy for the vaccine.  That file would look like\n\n.. code-block:: yaml\n\n    input_draw_count: 25\n    random_seed_count: 10\n\n    branches:\n      lri_vaccine:\n        coverage: [0.0, 0.2, 0.4, 0.8, 1.0]\n        efficacy: [0.4, 0.6, 0.8]\n\nThe branches file would overwrite your original ``lri_vaccine`` configuration\nwith each combination of coverage and efficacy in the branches file and launch\na simulation. More, it would run each coverage-efficacy pair in the branches\nfor each combination of input draw and random seed to produce 25 * 10 * 5 * 3 =\n3750 unique simulations.\n\nTo read about more of the available features and get a better understanding\nof how to correctly write your own branches files, check out the\n`vivarium cluster tools documentation <https://vivarium-cluster-tools.readthedocs.io/en/latest/?badge=latest>`_.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://stash.ihme.washington.edu/projects/CSTE/repos/vivarium_cluster_tools",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "vivarium-cluster-tools",
        "package_url": "https://pypi.org/project/vivarium-cluster-tools/",
        "platform": "",
        "project_url": "https://pypi.org/project/vivarium-cluster-tools/",
        "project_urls": {
            "Homepage": "https://stash.ihme.washington.edu/projects/CSTE/repos/vivarium_cluster_tools"
        },
        "release_url": "https://pypi.org/project/vivarium-cluster-tools/1.0.15/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A set of tools for running simulation using vivarium on cluster.",
        "version": "1.0.15"
    },
    "last_serial": 5818100,
    "releases": {
        "1.0.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2a24c6f90c9d477fa99120253168d3c6",
                    "sha256": "ec98b0ec81055a15f37e09a28839220907c3ddff944e3a61b8740924ab1b7cf6"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.10.tar.gz",
                "has_sig": false,
                "md5_digest": "2a24c6f90c9d477fa99120253168d3c6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21599,
                "upload_time": "2019-06-18T20:54:27",
                "url": "https://files.pythonhosted.org/packages/60/6c/0f8f5af4ca3882670429be370360254d9917e37ca128154275a527a8d0cf/vivarium_cluster_tools-1.0.10.tar.gz"
            }
        ],
        "1.0.11": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c688fde2ce745d4bd80d2abb30b2369a",
                    "sha256": "758d8f6c5220f2b1506653b33111433091e4c0dc1bfbe49435465d75c7d698b3"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.11.tar.gz",
                "has_sig": false,
                "md5_digest": "c688fde2ce745d4bd80d2abb30b2369a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21617,
                "upload_time": "2019-06-20T03:12:45",
                "url": "https://files.pythonhosted.org/packages/82/16/88d99c064844d7594496bcf3e71ea7665fe05af0c94c17ce99a1a9ca2b6f/vivarium_cluster_tools-1.0.11.tar.gz"
            }
        ],
        "1.0.12": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6fda75523065769fe1ab0ee939286387",
                    "sha256": "bec215818ef39d0b5b8d63b3d32d437c44244054751d1cd2dea8192b75ba5168"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.12.tar.gz",
                "has_sig": false,
                "md5_digest": "6fda75523065769fe1ab0ee939286387",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21640,
                "upload_time": "2019-06-21T00:40:11",
                "url": "https://files.pythonhosted.org/packages/d0/ca/b87a895eaeee338a91caf00fe8c506b6433c4cc05d36ad65ab9ae1a07c4e/vivarium_cluster_tools-1.0.12.tar.gz"
            }
        ],
        "1.0.14": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "43882dd5286f222e63aec2861462ba63",
                    "sha256": "ca1ec8565bf5f433a156ff65b90900e9633c416a3a2f6fe3518cedfff6ff2fb5"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.14.tar.gz",
                "has_sig": false,
                "md5_digest": "43882dd5286f222e63aec2861462ba63",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21644,
                "upload_time": "2019-06-21T00:58:30",
                "url": "https://files.pythonhosted.org/packages/43/ff/549dbf78b12d652d98251d24c59c51a23e5e886ac11dbbdf971470541109/vivarium_cluster_tools-1.0.14.tar.gz"
            }
        ],
        "1.0.15": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "88c13d3009a15ec15a30a72ab2f52fd2",
                    "sha256": "ffdc9413411f2d9a8a531796699a589492827ee6ecc86ffeeea806225ef5e7be"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.15.tar.gz",
                "has_sig": false,
                "md5_digest": "88c13d3009a15ec15a30a72ab2f52fd2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 23235,
                "upload_time": "2019-09-12T04:26:26",
                "url": "https://files.pythonhosted.org/packages/a9/ef/cfd85f4ab41e8041718fbfd6f2f2070a1cecb5619c4e3dd0824f00d2d4ce/vivarium_cluster_tools-1.0.15.tar.gz"
            }
        ],
        "1.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8b064cb37bb7a36e5c1eeac9dee5f331",
                    "sha256": "65c2ea085f7ec5cc6c2f5fb6d9aa3f5923e76f38742e0895bfe0a7f71ced84ba"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "8b064cb37bb7a36e5c1eeac9dee5f331",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13568,
                "upload_time": "2019-03-30T01:06:39",
                "url": "https://files.pythonhosted.org/packages/44/28/280f0ce611178526362cb21a3d96f26d8d36d0cc6e02fca980c4b71ad397/vivarium_cluster_tools-1.0.6.tar.gz"
            }
        ],
        "1.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c2873dd5be64b11042356cb6a8dce104",
                    "sha256": "2bffe30dad6d2ded6f00348fe74a7efc4a43f1c77da58f8a920df8cc4aef6ffc"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "c2873dd5be64b11042356cb6a8dce104",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14265,
                "upload_time": "2019-04-02T07:15:43",
                "url": "https://files.pythonhosted.org/packages/06/79/9ff151d6c90f095ea252b942bfc1292ba5cc3a62c3feecef6416bd15b985/vivarium_cluster_tools-1.0.7.tar.gz"
            }
        ],
        "1.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "68cc8428b923294580ffa2429f5e074f",
                    "sha256": "8df02f58222ca121a759ccc1998b3bb2a92f487586089a6826854cd8319eb81f"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "68cc8428b923294580ffa2429f5e074f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16189,
                "upload_time": "2019-04-16T16:45:18",
                "url": "https://files.pythonhosted.org/packages/58/61/6bf53bfc7b2cf2cca69ea76f3355e49959bb5df8dcc60e240b464c2270e6/vivarium_cluster_tools-1.0.8.tar.gz"
            }
        ],
        "1.0.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e8d60b54e41feb4cc0c1b7f87d3ccc91",
                    "sha256": "de2c696658aed557ef788c2ffc799bb43aec96218e698bbef39b7276199c155b"
                },
                "downloads": -1,
                "filename": "vivarium_cluster_tools-1.0.9.tar.gz",
                "has_sig": false,
                "md5_digest": "e8d60b54e41feb4cc0c1b7f87d3ccc91",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17237,
                "upload_time": "2019-04-23T02:12:03",
                "url": "https://files.pythonhosted.org/packages/e3/bb/dc07c154ffcf610fac27333b5e2a8ae4d3472967c7c4a8eec77a6088fa9c/vivarium_cluster_tools-1.0.9.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "88c13d3009a15ec15a30a72ab2f52fd2",
                "sha256": "ffdc9413411f2d9a8a531796699a589492827ee6ecc86ffeeea806225ef5e7be"
            },
            "downloads": -1,
            "filename": "vivarium_cluster_tools-1.0.15.tar.gz",
            "has_sig": false,
            "md5_digest": "88c13d3009a15ec15a30a72ab2f52fd2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23235,
            "upload_time": "2019-09-12T04:26:26",
            "url": "https://files.pythonhosted.org/packages/a9/ef/cfd85f4ab41e8041718fbfd6f2f2070a1cecb5619c4e3dd0824f00d2d4ce/vivarium_cluster_tools-1.0.15.tar.gz"
        }
    ]
}