Metadata-Version: 2.4
Name: plangraph
Version: 0.4.0
Summary: A Plan Graph for Goal Optimization (PGGO or 'pogo')
Author-email: Alec Ramsay <a73cram5ay@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/alecramsay/pggo
Project-URL: Bug Tracker, https://github.com/alecramsay/pggo/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rdapy
Requires-Dist: networkx
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# pggo

A redistricting plan graph for goal optimization (PGGO or "pogo")

## Installing the Package

To install the package:

```bash
pip install plangraph
```

The latest version of the package is 0.4.0.

Then in your code, either `import pggo` or `from pggo import ...`.
Note: The import name is different from the package name.

## Getting Started

```python
from pggo import PlanGraph

plan: PlanGraph = PlanGraph(
    "NC",
    "congress",
    "testdata/NC_congress_root_map.csv",
    "testdata/NC_input_data.jsonl",
    "testdata/NC_graph.json",
)
```

See [PlanGraph.md](docs/PlanGraph.md) for using a PlanGraph.
See [Metrics.md](docs/Metrics.md) for predefined metrics ("scores").

## Testing

Run automated tests with:

```bash
pytest
```

