Metadata-Version: 2.5
Name: fewsvisualiser
Version: 1.0.2
Summary: FEWSVisualiser: Insights for optimized Delft-FEWS configurations.
Project-URL: Source, https://github.com/delta-agents/fews-networkvisualisation
Author: Job Verkaik, Mattijn van Hoek, David Haasnoot
License: GNU-GPL V3
License-File: LICENSE
Keywords: configuration,declarative,delft-fews,insight
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8
Requires-Dist: fire
Description-Content-Type: text/markdown

# FEWSVisualiser: Insights for optimized Delft-FEWS configurations

A differerent approach to the analysis and visualisation of Delft-FEWS configuration

## Installing PyPi

`pip install fewsvisualiser`

Running:

`python -m fewsvisualiser analyse_config '../Config' 'Analysed_config.db3'`

## Data model

![Config Vis Datamodel](https://github.com/delta-agents/fews-networkvisualisation/blob/main/ConfigVisDatamodel.png?raw=true)

## Development

To manage the environment we use Pixi.

<details>
<summary>windows</summary>

```powershell
iwr -useb https://pixi.sh/install.ps1 | iex
```

</details>

<details>
<summary>Linux/Mac</summary>

```bash
curl -fsSL https://pixi.sh/install.sh | bash
```

</details>

### installing

With the `Pixi` command in powershell install the python environment:

```bash
 cd ../fews-networkvisualisation
 pixi install
```

The `pixi.lock` file loads the correct packages and downloads to the `.pixi` file, you can use this environment in developing and resting.

#### How to run when developing?

```bash
pixi install
```

```bash
pixi run analyse_config {path_to_config} {path_to_db}
# e.g: 
pixi run analyse_config  "..\FEWS Digiflow\Config" "db\digiflow.db3"
```
