sagesim

Name	sagesim JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	Scalable Agent-based GPU Enabled Simulator.
upload_time	2025-03-18 20:39:57
maintainer	None
docs_url	None
author	None
requires_python	>=3.11
license	MIT License Copyright (c) 2024 Oak Ridge National Laboratory Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	agent-based hpc gpu
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # SAGESim

Scalable Agent-based GPU Enabled Simulator

# Requirements

 - Python 3.11+
 - NVIDIA GPU with CUDA drivers or AMD GPU with ROCm 5.7.1+ 

# Installation

The most straightforward way is to use conda to install SAGESim and all dependencies:

Add to your current env: 

`conda env update --name myenv --file sagesim_all_deps.yml --prune`

or, create a new env:

`conda env create --name sagesimenv --file sagesim_all_deps.yml`

However, your system might require specific steps to installing `mpi4py` and/or `cupy` depending on your hardware.
In that case use your systems recommended instructions to install `mpi4py` and `cupy` and execute:

`pip install sagesim` 

# Run Example

 - `git clone https://code.ornl.gov/sagesim/sagesim`
 - `cd /path/to/clone_repo/examples/sir`
 - `mpiexec -n 4 python run.py`


# There are some unfortunate quirks to using CuPyx `jit.rawkernel`:
 - nan checked by inequality to self. Unfortunate limitation of cupyx.
 - Dicts and objects are unsupported.
 - *args and **kwargs are unsupported.
 - nested functions are unsupported.
 - Be sure to use `cupy` data types and array routines in favor of `numpy`: [https://docs.cupy.dev/en/stable/reference/routines.html]
 - `for` loops must use range iterator only. No 'for each' style loops.
 - `return` does not seem to work well either
 - `break` and `continue` are unsupported!
 - Cannot reassign variables within `if` or `for` statements. Must be assigned at top level of function or new variable declared under subscope.
 -  `-1` indexing does not necessarily work as expected, as it will access the last element of the memory block of the array instead of the logical array. Use `len(my_array) - 1` instead

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sagesim",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Chathika Gunaratne <chathikagunaratne@gmail.com>",
    "keywords": "agent-based, hpc, gpu",
    "author": null,
    "author_email": "Chathika Gunaratne <chathikagunaratne@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/0d/158627404ab65dc1c34efc7e88976b4b2ce661bed183383217d71c8f86be/sagesim-0.2.0.tar.gz",
    "platform": null,
    "description": "# SAGESim\n\nScalable Agent-based GPU Enabled Simulator\n\n# Requirements\n\n - Python 3.11+\n - NVIDIA GPU with CUDA drivers or AMD GPU with ROCm 5.7.1+ \n\n# Installation\n\nThe most straightforward way is to use conda to install SAGESim and all dependencies:\n\nAdd to your current env: \n\n`conda env update --name myenv --file sagesim_all_deps.yml --prune`\n\nor, create a new env:\n\n`conda env create --name sagesimenv --file sagesim_all_deps.yml`\n\nHowever, your system might require specific steps to installing `mpi4py` and/or `cupy` depending on your hardware.\nIn that case use your systems recommended instructions to install `mpi4py` and `cupy` and execute:\n\n`pip install sagesim` \n\n# Run Example\n\n - `git clone https://code.ornl.gov/sagesim/sagesim`\n - `cd /path/to/clone_repo/examples/sir`\n - `mpiexec -n 4 python run.py`\n\n\n# There are some unfortunate quirks to using CuPyx `jit.rawkernel`:\n - nan checked by inequality to self. Unfortunate limitation of cupyx.\n - Dicts and objects are unsupported.\n - *args and **kwargs are unsupported.\n - nested functions are unsupported.\n - Be sure to use `cupy` data types and array routines in favor of `numpy`: [https://docs.cupy.dev/en/stable/reference/routines.html]\n - `for` loops must use range iterator only. No 'for each' style loops.\n - `return` does not seem to work well either\n - `break` and `continue` are unsupported!\n - Cannot reassign variables within `if` or `for` statements. Must be assigned at top level of function or new variable declared under subscope.\n -  `-1` indexing does not necessarily work as expected, as it will access the last element of the memory block of the array instead of the logical array. Use `len(my_array) - 1` instead\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2024 Oak Ridge National Laboratory\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "Scalable Agent-based GPU Enabled Simulator.",
    "version": "0.2.0",
    "project_urls": {
        "Repository": "https://github.com/ornl/sagesim.git"
    },
    "split_keywords": [
        "agent-based",
        " hpc",
        " gpu"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "afd337df35172da52faa0ef23d35c2d7fddac8dd745c28de5325e9b54f31164c",
                "md5": "722446150e5b4645f19461fef0ff1683",
                "sha256": "829d0e35c78ad34c49ea74a2adb2584511a6b476be605c4465e3a1d723521d33"
            },
            "downloads": -1,
            "filename": "sagesim-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "722446150e5b4645f19461fef0ff1683",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 32016,
            "upload_time": "2025-03-18T20:39:56",
            "upload_time_iso_8601": "2025-03-18T20:39:56.617243Z",
            "url": "https://files.pythonhosted.org/packages/af/d3/37df35172da52faa0ef23d35c2d7fddac8dd745c28de5325e9b54f31164c/sagesim-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "540d158627404ab65dc1c34efc7e88976b4b2ce661bed183383217d71c8f86be",
                "md5": "ce560482cd66922c0a8ccd1c013b9f2b",
                "sha256": "f01af6843cf65a086b30f4ca279423a5cb828c6a4030ed90c85462167cc17bae"
            },
            "downloads": -1,
            "filename": "sagesim-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ce560482cd66922c0a8ccd1c013b9f2b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 16104,
            "upload_time": "2025-03-18T20:39:57",
            "upload_time_iso_8601": "2025-03-18T20:39:57.499588Z",
            "url": "https://files.pythonhosted.org/packages/54/0d/158627404ab65dc1c34efc7e88976b4b2ce661bed183383217d71c8f86be/sagesim-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-18 20:39:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ornl",
    "github_project": "sagesim",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "sagesim"
}