Skip to main content

The python version of JSONGrapher with tools for creating JSONGrapher Records.

Project description

Anaconda-Server Badge Anaconda-Server Badge

JSONGrapher (python)

Imagine a world where a person can simply drag a data file into a graphing utility and a plot will be made -- including axes with the data's units. Imagine that data from data other sources (with other units) can then be dragged in for comparison, with all data plotted on an interactive graph. Imagine that the units of all of these datasets will be converted automatically, as needed, during the plotting.

Create interactive plots just by drag-and-drop of JSON records. Share the json files for easy plotting by others. JSONGrapher will automatically convert units between records to plot the data sets together, to enable comparisons. For example, if one record is in kg/s and another in g/s, JSONGrapher will do the conversion automatically to plot both records together, for comparison. Tools and examples are included for how to create JSON records.

To use python JSONGrapher, first install it using conda or pip:
pip install JSONGrapher[COMPLETE] or conda install conda-forge::jsongrapher
Alternatively, you can download the directory directly.

0. Plotting a JSON Record

To create an interactive plot, you just need one line of code!
Then drag an example JSONGrapher record into the window to plot! Below are example 2D and 3D plots.
Further below shows how easy it is to create your own json records.

import JSONGrapher; JSONGrapher.launch()
# Then just drag records into the window!

      

   

1. Preparing to Create a Record

The remainder of this landing page follows a json record tutorial example which shows how to create graphable .json records. The records can then be plotted with python JSONGrapher or with jsongrapher.com

Let's create an example where we plot the height of a pear tree over several years.

Record = JSONRecordCreator.create_new_JSONGrapherRecord()
x_label_including_units = "Time (years)"
y_label_including_units = "Height (m)"
time_in_years = [0, 1, 2, 3, 4]
tree_heights = [0, 0.42, 0.86, 1.19, 1.45]

2. Populating the New JSONGrapher Record

Record.set_comments("Tree Growth Data collected from the US National Arboretum")
Record.set_datatype("Tree_Growth_Curve")
Record.set_x_axis_label_including_units(x_label_including_units)
Record.set_y_axis_label_including_units(y_label_including_units)
Record.add_data_series(series_name="pear tree growth", x_values=time_in_years, y_values=tree_heights, plot_type="scatter_spline")
Record.set_graph_title("Pear Tree Growth Versus Time")

3. Exporting to File

We can export a record to a .json file, which can then be used with JSONGrapher.

Record.export_to_json_file("ExampleFromTutorial.json")
Record.print_to_inspect()

Expected Output:

JSONGrapher Record exported to, ./ExampleFromTutorial.json
{
    "comments": "Tree Growth Data collected from the US National Arboretum",
    "datatype": "Tree_Growth_Curve",
    "data": [
        {
            "name": "pear tree growth",
            "x": [0, 1, 2, 3, 4],
            "y": [0, 0.42, 0.86, 1.19, 1.45],
            "type": "scatter",
            "line": { "shape": "spline" }
        }
    ],
    "layout": {
        "title": "Pear Tree Growth Versus Time",
        "xaxis": { "title": "Time (year)" },
        "yaxis": { "title": "Height (m)" }
    }
}

4. Plotting to Inspect

We can plot the data with plotly, interact with the graph, and save as a png file.

Record.plot_with_plotly() #Try hovering your mouse over points after this command!

We can plot the data using Matplotlib and export the plot as a PNG file.

Record.plot_with_matplotlib()
Record.export_to_matplotlib_png("image_from_tutorial_matplotlib_fig")

You can also see more examples: https://github.com/AdityaSavara/jsongrapher-py/tree/main/Tutorials

Additionally, json records you send to others can be plotted by them at www.jsongrapher.com This 'see the plot using a browser' capability is intended to facilitate including JSONGrapher records in supporting information of scientific publications.

Contributing to JSONGrapher, Feature Suggestions, and Reporting Issues

These interactions should be through github at https://github.com/AdityaSavara/jsongrapher-py

To contribute to JSONGrapher, make a pull request with sufficient details about what issue you are trying to solve, and adequate commenting in your code to follow the logic. After that, be prepared for further communication if needed.

To suggest features, create a new issue under the issues tab.

To report issues, create a new issue under the issues tab.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsongrapher-5.0.tar.gz (112.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jsongrapher-5.0-py3-none-any.whl (118.9 kB view details)

Uploaded Python 3

File details

Details for the file jsongrapher-5.0.tar.gz.

File metadata

  • Download URL: jsongrapher-5.0.tar.gz
  • Upload date:
  • Size: 112.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for jsongrapher-5.0.tar.gz
Algorithm Hash digest
SHA256 6ec82750d7a19d3aace24e82a779d39d0683f7d12c17cee94a8ce1097b405a3a
MD5 16a6b42983fb9a9e33e251868f3367e5
BLAKE2b-256 435031c56dd7413f72bce9a98f7fb9ecf024554e2d35b38a253f234d51bf1d82

See more details on using hashes here.

File details

Details for the file jsongrapher-5.0-py3-none-any.whl.

File metadata

  • Download URL: jsongrapher-5.0-py3-none-any.whl
  • Upload date:
  • Size: 118.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for jsongrapher-5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fd2247a0042f507fc42a58044ce7ba40e4bafffb51d13d3c944fc34bd44c1a6
MD5 1549119c3eb6ec47854790d6737f0d62
BLAKE2b-256 7f424e35796b282c44ee8263d1b9bacdcca04b3784140379f08fba51d895b753

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page