Metadata-Version: 2.4
Name: assume-gui
Version: 1.1.0
Summary: ASSUME - GUI
Author-email: ASSUME Developers <contact@assume-project.de>
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://assume-project.de/
Project-URL: Repository, https://github.com/assume-framework/assume-gui
Project-URL: Issues, https://github.com/assume-framework/assume-gui/issues
Keywords: agent based simulation,energy market,fastapi,user interface,simulation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Framework :: AsyncIO
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi[standard]>=0.119.0
Requires-Dist: assume-framework>=0.5.5
Requires-Dist: uvicorn>=0.37.0
Requires-Dist: pandas
Requires-Dist: httpx
Provides-Extra: all
Requires-Dist: assume-framework[all]>=0.5.5; extra == "all"
Provides-Extra: test
Requires-Dist: ruff>=0.4.9; extra == "test"
Requires-Dist: mypy>=1.1.1; extra == "test"
Requires-Dist: matplotlib>=3.7.2; extra == "test"
Requires-Dist: pytest>=7.2.2; extra == "test"
Requires-Dist: pytest-cov>=4.1.0; extra == "test"
Requires-Dist: pytest-asyncio>=0.21.1; extra == "test"
Dynamic: license-file

# Assume GUI
A simple frontend to create simulations using the ASSUME framework
## Start using docker
1. Get the `compose.yml` file
2. Run `docker compose -f compose.yml up` to start the app
Thats it!

## Build manually
### Prerequirements
1. Install node.js and npm, setup a python venv
2. Run `npm clean-install` to install frontend dependencies
3. Install backend dependencies using `pip install .`
4. (May sometimes be required)_ Use `pip install git+https://github.com/assume-framework/assume` for most recent changes of the assume framework
### Start the app in dev mode
1. Run `npm run dev` to start the frontend
2. Start the backend server with `python backend/main.py`

### Build the frontend for production
1. Run `npm run build` to build the frontend
2. Start the backend server with `python backend/main.py` (the backend will serve the built frontend)

