Metadata-Version: 2.1
Name: symphony_data_map
Version: 1.0.2
Summary: A Symphony component for visualizing data on a map
Home-page: https://github.com/apple/ml-symphony
Author: Apple
Author-email: dnikit-symphony-oss@group.apple.com
License: Apple Sample Code License
Keywords: Jupyter,Widgets,IPython
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Jupyter
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: examples
Provides-Extra: docs
License-File: LICENSE.txt

# SymphonyDataMap

A rendered map where landmarks are colored by another variable.
To configure the map, the spec of this component is defined as follows:

```
@dataclass
class DataMapSpec(WidgetSpec):
    projection: str
    id_map: dict
    feature: str
    id_column: str
    map_url: str
```

The projection is a `vega-projection`, the `id_map` maps names to multiple `id` in a TopoJSON, the `feature` defines what column to color by, the `id_column` defines where names are to be found, and the `map_url` provides a link to the appropriate TopoJSON.

## Installation

```bash
pip install symphony_data_map
```

## Usage

To learn how to use Symphony, see the [documentation](https://apple.github.io/ml-symphony/).

## Development

To learn about how to build Symphony from source and how to contribute to the framework, please look at [CONTRIBUTING.md](../CONTRIBUTING.md) and the [development documentation](https://apple.github.io/ml-symphony/contributing.html).
