Metadata-Version: 2.1
Name: explorationViewer
Version: 0.1
Summary: Tool for interactively visualizing decision graphs produced by the 'exploration' module. By default runs a local HTTP server to serve an HTML file and opens that file in the browser.
Home-page: https://cs.wellesley.edu/~pmwh/mvmap/egviewer/docs/explorationViewer
Author: Peter Mawhorter
Author-email: pmawhort@wellesley.edu
License: BSD 3-Clause License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: exploration
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# ExplorationViewer

## Overview

This program provides an interactive HTML visualization platform for data
produced by the `exploration` module, most notably
`exploration.core.Exploration` objects. It is partially based on the
`dewlight` visualizer for literary character interaction graphs.

## Dependencies:

Just Python version 3.10+ (might work on lower versions; probably not below
3.6). You will also need the `exploration` library.

## Installing

Just run `pip install explorationViewer`. This will install several dozen
megabytes of `pyodide` support files since the viewer uses
Python-in-the-browser.

## Getting Started:

Running `python -m explorationViewer` should launch a web server and via
that open the viewer HTML file in your default web browser. It will load an
example exploration but you can use the in-page controls to load another
file of your choice.

TODO: Support providing a filename on the command line.

## Changelog

- v0.1 Initial pre-alpha upload.
