jsongrapher 1.6__py3-none-any.whl

jsongrapher-1.6.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.1
+Name: jsongrapher
+Version: 1.6
+Summary: A python package for creating JSONGrapher Records.
+Home-page: https://github.com/AdityaSavara/JSONGrapherRC
+Author: Aditya Savara
+Author-email: AditySavara2008@u.northwestern.edu
+License: Unlicense
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.0.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: complete
+Requires-Dist: matplotlib; extra == "complete"
+
+
+# JSONGrapherRC
+A python package for creating JSONGrapher Records
+
+To use JSONGrapherRC, first install it using pip:
+<pre>
+pip install JSONGrapherRC[COMPLETE]
+</pre>
+
+Alternatively, you can download the directory directly.<br> 
+It is easiest to then follow the [example file](https://github.com/AdityaSavara/JSONGrapherRC/blob/main/example/exampleUsageJSONRecordCreator.py) to learn.<br>
+
+
+## **1\. Preparing to Create a Record**
+
+Let's create an example where we plot the height of a pear tree over several years. Assuming a pear tree grows approximately 0.40 meters per year, we'll generate sample data with some variation.
+<pre>
+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]
+</pre>
+
+## **2\. Creating and Populating a New JSONGrapher Record**
+
+The easiest way to start is with the `create_new_JSONGrapherRecord()` function. While you *can* instantiate the JSONGrapherRecord class directly, this function is generally more convenient. We'll create a record and inspect its default fields.
+<pre>
+try:
+    from JSONGRapherRC import JSONRecordCreator  # Normal usage
+except ImportError:
+    import JSONRecordCreator  # If the class file is local
+
+Record = JSONRecordCreator.create_new_JSONGrapherRecord()
+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")
+</pre>
+
+## **3\. Exporting to File**
+
+We now have a JSONGrapher record! We can export it to a file, which can then be used with JSONGrapher. 
+<pre>
+Record.export_to_json_file("ExampleFromTutorial.json")
+Record.print_to_inspect()
+</pre>
+
+<p><strong>Expected Output:</strong></p>
+<pre>
+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)" }
+    }
+}
+</pre>
+
+
+We can also plot the data using Matplotlib and export the plot as a PNG file.
+<pre>
+Record.plot_with_matplotlib()
+Record.export_to_matplotlib_png("ExampleFromTutorial")
+</pre>
+
+[![JSONGRapher record plotted using matplotlib](https://raw.githubusercontent.com/AdityaSavara/JSONGrapherRC/main/example/ExampleFromTutorial.png)](https://raw.githubusercontent.com/AdityaSavara/JSONGrapherRC/main/example/ExampleFromTutorial.png)

jsongrapher-1.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+JSONGrapher/JSONRecordCreator.py,sha256=_dfVxwy7itw3mUq7G_akyeup5KEy6KHXLeiINAzhHqg,45957
+JSONGrapher/__init__.py,sha256=YvI9lnzN8e6jfCF--fuyiNZYq_YiVM72osipYjmWLAA,279
+JSONGrapher/units_list.py,sha256=ARlPgvKWZM8um1FA7OtzDjnJhl0zy1X4vGbTQN93MnQ,33074
+jsongrapher-1.6.data/data/LICENSE,sha256=KrPIO2Ij3T_47dfpfngKzpC4EXohIZMsHauG0R4M-kM,1234
+jsongrapher-1.6.data/data/README.md,sha256=9UIVwsfi9CtLWzRFTnMiWvRiFf7MZLzmlWOpuOrj8e8,3036
+jsongrapher-1.6.dist-info/LICENSE,sha256=KrPIO2Ij3T_47dfpfngKzpC4EXohIZMsHauG0R4M-kM,1234
+jsongrapher-1.6.dist-info/METADATA,sha256=sLXqe5taldI3P4ASryDjexbue9uH8p2bY3Gnb3nZvHw,3913
+jsongrapher-1.6.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+jsongrapher-1.6.dist-info/top_level.txt,sha256=5f7Ui2hCKCPTQOjD540WKghKNYOvUDNfdpnDbIlAD3Y,12
+jsongrapher-1.6.dist-info/RECORD,,

jsongrapher-1.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.45.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

jsongrapher-1.6.dist-info/top_level.txt

@@ -0,0 +1 @@
+JSONGrapher