flee


Nameflee JSON
Version 3.1 PyPI version JSON
download
home_pagehttps://flee.readthedocs.io
SummaryFlee is an agent-based modelling toolkit which is purpose-built for simulating the movement of individuals across geographical locations.
upload_time2023-08-25 07:50:51
maintainer
docs_urlNone
authorDerek Groen
requires_python>=3.8
licenseBSD-3-Clause
keywords flee
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Flee
[![Build Status](https://travis-ci.com/djgroen/flee.svg?branch=master)](https://travis-ci.com/djgroen/flee)
[![GitHub Issues](https://img.shields.io/github/issues/djgroen/flee.svg)](https://github.com/djgroen/flee/issues)
[![GitHub last-commit](https://img.shields.io/github/last-commit/djgroen/flee.svg)](https://github.com/djgroen/flee/commits/master)


Flee is an agent-based modelling toolkit which is purpose-built for simulating
the movement of individuals across geographical locations. Flee is currently
used primarily for modelling the movements of forcibly displaced
persons (FDPs).

Full documentation of Flee is available at https://flee.readthedocs.io.

Official releases will be done on https://www.github.com/djgroen/flee. (flee-release is deprecated and will be removed in due course.)

## Parallel performance testing

Parallel tests can be performed using test_par.py. The interface is as follows:

mpirun -np <cores> python3 tests/test_par.py [options]
  
Options can be as follows:

* "-p", "--parallelmode" - Parallelization mode ([advanced], classic, cl-hilat OR adv-lowlat).
* "-N", "--initialagents" - Number of agents at the start of the simulation [100000].
* "-d", "--newagentsperstep", Number of agents added per time step [1000].
* "-t", "--simulationperiod", Duration of the simulation in days [10].

Here are a few settings good for benchmarking:

* `mpirun -np <cores> python3 test_par.py -N 500000 -p advanced -d 10000 -t 10`
* `mpirun -np <cores> python3 test_par.py -N 500000 -p classic -d 10000 -t 10`
* `mpirun -np <cores> python3 test_par.py -N 500000 -p cl-hilat -d 10000 -t 10`
* `mpirun -np <cores> python3 test_par.py -N 500000 -p adv-lowlat -d 10000 -t 10`


# Acknowledgements
The development on Flee has been made possible through funding from the Horizon 2020 funded HiDALGO project (grant no. 824115, https://hidalgo-project.eu) and VECMA (grant no. 800925, https://www.vecma.eu).

            

Raw data

            {
    "_id": null,
    "home_page": "https://flee.readthedocs.io",
    "name": "flee",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "flee",
    "author": "Derek Groen",
    "author_email": "Derek.Groen@brunel.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/d4/06/4e7be8c97c855f5b9cca9b62ffa7a3fc35592a12108640039bc9a0ee4354/flee-3.1.tar.gz",
    "platform": null,
    "description": "# Flee\n[![Build Status](https://travis-ci.com/djgroen/flee.svg?branch=master)](https://travis-ci.com/djgroen/flee)\n[![GitHub Issues](https://img.shields.io/github/issues/djgroen/flee.svg)](https://github.com/djgroen/flee/issues)\n[![GitHub last-commit](https://img.shields.io/github/last-commit/djgroen/flee.svg)](https://github.com/djgroen/flee/commits/master)\n\n\nFlee is an agent-based modelling toolkit which is purpose-built for simulating\nthe movement of individuals across geographical locations. Flee is currently\nused primarily for modelling the movements of forcibly displaced\npersons (FDPs).\n\nFull documentation of Flee is available at https://flee.readthedocs.io.\n\nOfficial releases will be done on https://www.github.com/djgroen/flee. (flee-release is deprecated and will be removed in due course.)\n\n## Parallel performance testing\n\nParallel tests can be performed using test_par.py. The interface is as follows:\n\nmpirun -np <cores> python3 tests/test_par.py [options]\n  \nOptions can be as follows:\n\n* \"-p\", \"--parallelmode\" - Parallelization mode ([advanced], classic, cl-hilat OR adv-lowlat).\n* \"-N\", \"--initialagents\" - Number of agents at the start of the simulation [100000].\n* \"-d\", \"--newagentsperstep\", Number of agents added per time step [1000].\n* \"-t\", \"--simulationperiod\", Duration of the simulation in days [10].\n\nHere are a few settings good for benchmarking:\n\n* `mpirun -np <cores> python3 test_par.py -N 500000 -p advanced -d 10000 -t 10`\n* `mpirun -np <cores> python3 test_par.py -N 500000 -p classic -d 10000 -t 10`\n* `mpirun -np <cores> python3 test_par.py -N 500000 -p cl-hilat -d 10000 -t 10`\n* `mpirun -np <cores> python3 test_par.py -N 500000 -p adv-lowlat -d 10000 -t 10`\n\n\n# Acknowledgements\nThe development on Flee has been made possible through funding from the Horizon 2020 funded HiDALGO project (grant no. 824115, https://hidalgo-project.eu) and VECMA (grant no. 800925, https://www.vecma.eu).\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Flee is an agent-based modelling toolkit which is purpose-built for simulating the movement of individuals across geographical locations.",
    "version": "3.1",
    "project_urls": {
        "Homepage": "https://flee.readthedocs.io"
    },
    "split_keywords": [
        "flee"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8aa10386702b4e394f15ef0ab614197b60240fae7267ad04b85615d7b410dd40",
                "md5": "a68fabaad70a046aeb21e44caf5274ca",
                "sha256": "3a7fd15f5b6ae028fb4b94285c8e9d2e1ae06501113446e7fdbe83331208bb25"
            },
            "downloads": -1,
            "filename": "flee-3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a68fabaad70a046aeb21e44caf5274ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 91618,
            "upload_time": "2023-08-25T07:50:50",
            "upload_time_iso_8601": "2023-08-25T07:50:50.099157Z",
            "url": "https://files.pythonhosted.org/packages/8a/a1/0386702b4e394f15ef0ab614197b60240fae7267ad04b85615d7b410dd40/flee-3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d4064e7be8c97c855f5b9cca9b62ffa7a3fc35592a12108640039bc9a0ee4354",
                "md5": "cc3ec2cf70b0ba42fa2f0d856f6b4b73",
                "sha256": "5a2ff1f501eb76bbe41f8d28fa5b973ff7e8a643cd1156820571fc4b3b6f2fb7"
            },
            "downloads": -1,
            "filename": "flee-3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cc3ec2cf70b0ba42fa2f0d856f6b4b73",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 93306,
            "upload_time": "2023-08-25T07:50:51",
            "upload_time_iso_8601": "2023-08-25T07:50:51.202860Z",
            "url": "https://files.pythonhosted.org/packages/d4/06/4e7be8c97c855f5b9cca9b62ffa7a3fc35592a12108640039bc9a0ee4354/flee-3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-25 07:50:51",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "flee"
}
        
Elapsed time: 0.26952s