Metadata-Version: 2.1
Name: famegui
Version: 0.8.0
Summary: Graphical user interface to the FAME modelling framework
Home-page: https://gitlab.com/fame-framework/FAME-Gui
Download-URL: https://gitlab.com/fame-framework/FAME-Gui/-/archive/v0.8.0/FAME-Gui-v0.8.0.tar.gz
Author: Aurélien Regat-Barrel, Simon Wischnevetski
Author-email: fame@dlr.de
License: Apache License 2.0
Keywords: FAME,agent-based modelling
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

[![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 .`.


