README.md

Falx

An opportunistic programming tool for visualizations to make design easier.

Set up

Requirement: Python version >=3.7.

Create virtual environment (recommended)

Virtual Environment is recommended for managing dependencies.

If using Virtual Environment:

mkdir venv
python3 -m venv ./venv
source venv/bin/activate

At development time, use source venv/bin/activate (venv) or source activate falx (conda) to activate the virtual environment.

Install dependencies

1. Install python dependencies: pip install -r requirements.txt

2. Install falx in the development mode: pip install -e .

Run

To run the Falx: cd falx; python3 interface.py

To run Falx as a server: cd server; env FLASK_APP=server.py flask run