[![PyPI version](https://badge.fury.io/py/famegui.svg)](https://badge.fury.io/py/famegui)
[![PyPI license](https://img.shields.io/pypi/l/famegui.svg)](https://badge.fury.io/py/famegui)
[![pipeline status](https://gitlab.com/fame-framework/FAME-Gui/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/FAME-Gui/commits/main)
[![coverage report](https://gitlab.com/fame-framework/FAME-Gui/badges/main/coverage.svg)](https://gitlab.com/fame-framework/FAME-Gui/-/commits/main)
# FAME-Gui
Graphical user interface for FAME models.
Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/fame-wiki/-/wikis/home) to get an explanation of FAME and its components.
This is a Beta version - see current development [milestones](https://gitlab.com/fame-framework/FAME-Gui/-/milestones).
# Installation
pip install famegui
You may also use `pipx`. For detailed information please refer to the official `pipx` [documentation](https://github.com/pypa/pipx).
pipx install famegui
# Usage
FAME-Gui is started in the console using
famegui
# Contribute
Please read the Contributors License Agreement `cla.md`, sign it and send it to [`fame@dlr.de`](mailto:fame@dlr.de) before contributing.
## Testing changes locally
Once some changes have been performed on the local git clone, use the following command to override your local installation with your modified copy in order to test the result:
```bash
python3 setup.py bdist_wheel && pip3 install --force-reinstall --no-dependencies ./dist/*.whl
```
## Code style
We use the code formatting library [`black`](https://pypi.org/project/black/).
The maximum line length is defined as 120 characters.
Therefore, before committing, run `black --line-length 120 .`.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/fame-framework/FAME-Gui",
"name": "famegui",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "FAME,agent-based modelling",
"author": "Aur\u00e9lien Regat-Barrel, Simon Wischnevetski",
"author_email": "fame@dlr.de",
"download_url": "https://files.pythonhosted.org/packages/58/22/4600dc04ca58550684ccb6f684d923e1e97185e321f43338e305db888285/famegui-0.8.0.tar.gz",
"platform": null,
"description": "[![PyPI version](https://badge.fury.io/py/famegui.svg)](https://badge.fury.io/py/famegui)\n[![PyPI license](https://img.shields.io/pypi/l/famegui.svg)](https://badge.fury.io/py/famegui)\n[![pipeline status](https://gitlab.com/fame-framework/FAME-Gui/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/FAME-Gui/commits/main)\n[![coverage report](https://gitlab.com/fame-framework/FAME-Gui/badges/main/coverage.svg)](https://gitlab.com/fame-framework/FAME-Gui/-/commits/main) \n\n# FAME-Gui\nGraphical user interface for FAME models.\nPlease visit the [FAME-Wiki](https://gitlab.com/fame-framework/fame-wiki/-/wikis/home) to get an explanation of FAME and its components.\nThis is a Beta version - see current development [milestones](https://gitlab.com/fame-framework/FAME-Gui/-/milestones).\n\n# Installation\n\n pip install famegui\n\n\nYou may also use `pipx`. For detailed information please refer to the official `pipx` [documentation](https://github.com/pypa/pipx).\n\n pipx install famegui\n\n\n# Usage\nFAME-Gui is started in the console using\n\n famegui\n\n\n# Contribute\nPlease read the Contributors License Agreement `cla.md`, sign it and send it to [`fame@dlr.de`](mailto:fame@dlr.de) before contributing.\n\n## Testing changes locally\n\nOnce some changes have been performed on the local git clone, use the following command to override your local installation with your modified copy in order to test the result:\n\n```bash\npython3 setup.py bdist_wheel && pip3 install --force-reinstall --no-dependencies ./dist/*.whl\n```\n\n## Code style\n\nWe use the code formatting library [`black`](https://pypi.org/project/black/).\nThe maximum line length is defined as 120 characters. \nTherefore, before committing, run `black --line-length 120 .`.\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Graphical user interface to the FAME modelling framework",
"version": "0.8.0",
"project_urls": {
"Download": "https://gitlab.com/fame-framework/FAME-Gui/-/archive/v0.8.0/FAME-Gui-v0.8.0.tar.gz",
"Homepage": "https://gitlab.com/fame-framework/FAME-Gui"
},
"split_keywords": [
"fame",
"agent-based modelling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5bd2abe5b9dc0738cff4a949458893c17050023c8d29659dfd70beffc4c240a4",
"md5": "f955913798ffa5e582d386f8223b8903",
"sha256": "b0e41aaca58dff0ef15d33a50e138517344f8e558d3c7bfd76b728f0b494dc20"
},
"downloads": -1,
"filename": "famegui-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f955913798ffa5e582d386f8223b8903",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 124390,
"upload_time": "2023-11-15T17:20:47",
"upload_time_iso_8601": "2023-11-15T17:20:47.874861Z",
"url": "https://files.pythonhosted.org/packages/5b/d2/abe5b9dc0738cff4a949458893c17050023c8d29659dfd70beffc4c240a4/famegui-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58224600dc04ca58550684ccb6f684d923e1e97185e321f43338e305db888285",
"md5": "c8c63baec89e5db5db612940243dfcbd",
"sha256": "aec08dcd6d1c2aadb7c93910abcc6b7551c9d0341aa794546754cfec2a65652b"
},
"downloads": -1,
"filename": "famegui-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "c8c63baec89e5db5db612940243dfcbd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 100005,
"upload_time": "2023-11-15T17:20:53",
"upload_time_iso_8601": "2023-11-15T17:20:53.238745Z",
"url": "https://files.pythonhosted.org/packages/58/22/4600dc04ca58550684ccb6f684d923e1e97185e321f43338e305db888285/famegui-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 17:20:53",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "fame-framework",
"gitlab_project": "FAME-Gui",
"lcname": "famegui"
}