README.md

tredify

A Python framework to plot 2D and 3D structures from JSON data.

Requirements

• matplotlib
• numpy

Install

Install dependences with conda (recommended):

Create an environment

conda create -n tredifyenv python=2.7

Activate environment

source activate tredifyenv

Install packages

conda install numpy

conda install matplotlib

-- or launch setup.sh file

sudo chmod +x setup.sh

./setup.sh

-- GIS / geoJSON

If you also want to manage GIS data, you have to install other requirements:

• GEOS engine and Basemap

conda install geos

conda install basemap

• geojson

pip install geojson

Use

python tredify.py -i {JSON file path} -t {bar,scatter,pie,animation} -d {2D,3D} -v {gui,image}

If you choose GUI view, it will be prompt the classical matplotlib interface

To generate structures from geoJSON file:

python tredify.py -i {JSON file path} -gis {geoJSON structure [point,linestring,...]}

Animation only works with gui visualization. On utils/ there is a csv2json.py tool to convert sequences of csv files containing particles positions into a suitable json for tredify. utils/ contains a testdata folder with data produced by a simple 3 body simulation of the Sun-Earth-Jupiter system. The expected file format is csv and each file represent a point in time. It is assumed that the file has at least 3 columns for the x, y and z position of each particle.

python csv2json.py -i {folder containing csv files} -o {output json file} -s {number of lines to skip}

Stable Release

Clone master branch of this repo:

git clone https://github.com/gsalvatori/tredify/

or download the latest release from here

Development release

git clone -b development https://github.com/gsalvatori/tredify/

JSON and plots examples

Scatter

[
    {
        "x": 0.30148,
        "y": 2.4615,
        "z": 3
    },
    {
        "x": -0.29836,
        "y": -2.0909,
        "z": 2
    },
    {
        "x": -1.0465,
        "y": -6.3393,
        "z": 3
    }
]

Bar

[
    {
        "DIRECTION": "y"
    },
    {
        "xs": [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],
        "ys": [
            0.13637986,
            0.81848763,
            0.94809069,
            0.81352269,
            0.94943976,
            0.33354841,
            0.14769246,
            0.66518745,
            0.6922248,
            0.47103811,
            0.03248075,
            0.30346144,
            0.00491906,
            0.1544151,
            0.4929639,
            0.33019535,
            0.76123614,
            0.97240316,
            0.89122254,
            0.0263647
        ],
        "zs": 30
    }
]

Pie

[
    {
        "LABEL": "Drama",
        "PERCENTAGE":20,
        "EXPLODE": "False"
    },
    {
        "LABEL": "Scifi",
        "PERCENTAGE":60,
        "EXPLODE": "False" 
    },
    {
        "LABEL": "Action",
        "PERCENTAGE": 10,
        "EXPLODE": "True"
    },
    {
        "LABEL": "Romance",
        "PERCENTAGE": 10,
        "EXPLODE": "True"
    }
]

other features soon...