bridges 3.4.4__tar.gz → 3.4.5.dev1__tar.gz

{bridges-3.4.4/bridges.egg-info → bridges-3.4.5.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bridges
-Version: 3.4.4
+Version: 3.4.5.dev1
 Summary: Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES
 Home-page: https://github.com/BridgesUNCC/bridges-python
 Author: BRIDGES

bridges-3.4.5.dev1/bridges/bar_chart.py

@@ -0,0 +1,214 @@
+import json
+
+
+class BarChart:
+    """
+    @brief Support for drawing Bar charts.
+ 
+    Bar charts (https://en.wikipedia.org/wiki/Bar_chart) are used to
+    represent categorical data as a series of rectangular bars with length
+    proportional to the values they represent.
+    
+    Series in a bar chart provides data for a number of categories
+    (sometimes called bins). Categories are defined using
+    BarChart.categories and the series are added using BarChart.add_data_series().
+    The series are rendered in the order in which they were added. Once
+    a series has been added, it can not be modified.
+    
+    One should always define the categories before adding data. Changing the
+    categories after series have been added will throw exceptions;
+    adding series with different number of values than the number of
+    categories will throw an exception.
+    
+    The Bar charts can have a title, subtitle. The charts can be
+    horizontal or vertically oriented, using BarChart.orientation.
+    
+    A tooltip indicating the value of a series in a particular bin is
+    displayed by hovering on a bar. One can append a string to the
+    value using barchart.tooltip_suffix to specify units in the tooltip if desired.
+    
+      @sa See tutorial on using BarChart at:
+       https://bridgesuncc.github.io/tutorials/BarChart.html
+    """
+
+    # constructor method
+
+    def __init__(self):
+        self._c_label = ""
+        self._v_label = ""
+        self._title = ""
+        self._sub_title = ""
+        self._tt_suffix = ""
+        self._orientation = "horizontal"
+        self._series_data = []
+        self._cats = []
+
+    # simple getters and setters to access attributes
+    def get_data_structure_type(self):
+        return "BarChart"
+
+
+    @property
+    def title(self) -> str:
+        """
+        Title of the plot
+        """
+        return self._title
+
+    @title.setter
+    def title(self, plot_title: str) -> None:
+        """
+        Title of the plot
+        """
+        self._title = plot_title
+
+    @property
+    def sub_title(self) -> str:
+        """
+        Subtitle of the plot
+        """
+        return self._sub_title
+
+    @sub_title.setter
+    def sub_title(self, plot_sub_title: str) -> None:
+        """
+        Subtitle of the plot
+        """
+        self._sub_title = plot_sub_title
+
+    @property
+    def value_label(self) -> str:
+        """
+        Label for the value axis
+        """
+        return self._v_label
+
+    @value_label.setter
+    def value_label(self, value_label: str) -> None:
+        """
+        Label for the value axis
+        """
+        self._v_label = value_label
+
+    @property
+    def categories_label(self) -> str:
+        """
+        Label for the categories axis
+        """
+        return self._c_label
+
+    @categories_label.setter
+    def categories_label(self, c_label: str) -> None:
+        """
+        Label for the categories axis
+        """
+        self._c_label = c_label
+
+    @property
+    def orientation(self) -> str:
+        """
+        Orientation of the bar chart.
+
+        Will always be either "horizontal" or "vertical"
+        """
+        return self._orientation
+
+    @orientation.setter
+    def orientation(self, orient) -> str:
+        """
+        Sets orientation of the bar chart.
+
+        Must be either "horizontal" or "vertical". Will throw an exception otherwise.
+        """
+        if orient != "horizontal" and orient != "vertical":
+            raise ValueError ("Bar chart orientation must be either \"horizontal\" or \"vertical\"")
+        self._orientation = orient
+
+    @property
+    def tooltip_suffix(self) -> str:
+        """
+        the tooltip suffix
+        
+        This string is appended to the values in the hover tooltip.
+        """
+        return self._tt_suffix
+
+    @tooltip_suffix.setter
+    def tooltip_suffix(self, suffix: str) -> None:
+        """
+        the tooltip suffix
+        
+        This string is appended to the values in the hover tooltip.
+        """
+        self._tt_suffix = suffix
+
+    @property
+    def categories(self) -> list[str]:
+        """
+        Categories for this bar chart
+        """
+        return self._cats
+
+    @categories.setter
+    def categories(self, series_bins: list[str]) -> None:
+        """
+        Set the categories for the bar chart
+
+        will throw an exception if there are already data series defined.
+        """
+        if len (self._series_data) >0:
+            raise RuntimeError("Can't change categoriess after series have been added.")
+        self._cats = series_bins
+
+    def add_data_series(self, name:str, values:list[float]) -> None:
+        """ 
+        Add a series of data
+        
+        This will throw an exception if the data vector does not have the same	 
+        size as the number of categories.
+				 
+	This will throw exceptions if two series have the same name.
+	
+	Args:
+           name indicates the name of the data to add
+           values values of that serie for each category
+        """
+        if len(values) != len (self.categories):
+            raise ValueError("The data vector should have the same size as the number of categories.")
+
+        for others in self._series_data:
+            if name == others[0]:
+                raise ValueError("Can't have two series with the same name.")
+        
+        self._series_data.append ((name, values))
+
+    #Gets the data structure representation as a JSON string
+    #Returns: data structure reprsentation (json string)
+    def get_data_structure_representation(self):
+        bins = {
+            "xAxis": {
+                "categories": self.categories
+            }
+        }
+        series = []
+        for key, value in self._series_data:
+            temp_dict = {
+                "name": key,
+                "data": value
+            }
+            series.append(temp_dict)
+        #print(series)
+        json_dict = {
+            "plot_title": self.title,
+            "subtitle": self.subtitle,
+            "x_label": self.categories_label,
+            "y_label": self.value_label,
+            "tooltip_suffix": self.tooltip_suffix,
+            "alignment": self.orientation,
+            "xaxis_data": { "xAxis": {"categories": self.categories} },
+            "yaxis_data": {"series": series}
+        }
+        json_output = json.dumps(json_dict)
+        return json_dict
+
+

{bridges-3.4.4 → bridges-3.4.5.dev1}/bridges/bridges.py

@@ -100,7 +100,7 @@ class Bridges:
         self._link_label_flag = False
         self._post_url_flag = True
         self._map_overlay = False
-        self._map = ["us", "all"]
+        self.map = {}
         self._window = [0.0, 0.0, 0.0, 0.0]
         self.ds_handle = None
         self.vis_type = ""
@@ -168,6 +168,16 @@ class Bridges:
         """
         self._json_flag = flag
 
+    def set_map(self, map_info:list):
+        """
+        This method serializes all the state and county objects in the map_info for sending to the server
+        :param map_info: is a list of state objects with their counties
+        :return: none
+        """
+        self.map = map_info
+
+
+
     def post_visualization_link(self, flag:bool):
         """
         This method controls (with a flag) if the visualization url is printed to the console or not.
@@ -182,7 +192,7 @@ class Bridges:
         Returns:
             None
         """
-        nodes_links_str = ""
+        ds_str = ""
 
         if self.vis_type == "Tree" or self.vis_type == "BinaryTree" or self.vis_type == "AVLTree" or\
                 self.vis_type == "SinglyLinkedList" or self.vis_type == "DoublyLinkedList" or \
@@ -190,11 +200,11 @@ class Bridges:
                 self.vis_type == "CircularDoublyLinkedList" or self.vis_type == "Array" or \
                 self.vis_type == "GraphAdjacencyList" or self.vis_type == "ColorGrid" or self.vis_type == "GraphAdjacencyMatrix" or \
                 self.vis_type == "largegraph" or self.vis_type == "KdTree" or self.vis_type == "SymbolCollection" or \
-                self.vis_type == "GameGrid" or self.vis_type == "BinarySearchTree" or self.vis_type == "LineChart" or \
+                self.vis_type == "GameGrid" or self.vis_type == "BinarySearchTree" or self.vis_type == "LineChart" or self.vis_type == "BarChart" or \
                 self.vis_type == "Audio" or self.vis_type == "SymbolCollectionV2" or self.vis_type == "Scene":
-            nodes_links_str = self.ds_handle.get_data_structure_representation()
+            ds_str = self.ds_handle.get_data_structure_representation()
 
-        ds = {
+        ds_dict = {
             "visual": self.vis_type,
             "title": self._title,
             "description": self._description,
@@ -202,14 +212,15 @@ class Bridges:
             "map_overlay": self._map_overlay,
             "element_label_flag": self._element_label_flag,
             "link_label_flag": self._link_label_flag,
-            "map": self._map,
+            "map": self.map,
         }
         if self.window is not None and len(self.window) == 4:
-            ds['window'] = self.window
+            ds_dict['window'] = self.window
 
-        ds.update(nodes_links_str)
+        ds_dict.update(ds_str)
 
-        ds_json = json.dumps(ds)
+        #adds default for serializing objects
+        ds_json = json.dumps(ds_dict, default = lambda x: x.__dict__)
         if self._json_flag or self._debug:
             print(ds_json)
 
@@ -290,21 +301,21 @@ class Bridges:
         """
         self._map_overlay = flag
 
-    @property
-    def map(self)->list:
-        return self._map
-
-    @map.setter
-    def map(self, new_map:list) ->None:
-        """
-        Setter function for the svg map overlay describing which map to use and the information from that map.
-        Args:
-            new_map: is a list with the first element describing which map: "us" or "world", and the second element
-        describing what part of the map: a state name or country name respectively.
-        Returns:
-            None
-        """
-        self._map = new_map
+    # @property
+    # def map(self)->list:
+    #     return self._map
+
+    # @map.setter
+    # def map(self, new_map:list) ->None:
+    #     """
+    #     Setter function for the svg map overlay describing which map to use and the information from that map.
+    #     Args:
+    #         new_map: is a list with the first element describing which map: "us" or "world", and the second element
+    #     describing what part of the map: a state name or country name respectively.
+    #     Returns:
+    #         None
+    #     """
+    #     self._map = new_map
 
     def set_coord_system_type(self, coord):
         """

bridges-3.4.5.dev1/bridges/data_src_dependent/county.py

@@ -0,0 +1,77 @@
+
+
+class County:
+
+    def __init__(self, id: str, code: str, county: str, state: str):
+        self._geoid = id
+        self._fips_code = code
+        self._county_name = county
+        self._state_name = state
+        self._stroke_color = 'green'
+        self._stroke_width = 0.5
+        self._fill_color = 'blue'
+        self._hide = False
+
+    @property
+    def geoid(self):
+        return self._geoid
+
+    @geoid.setter
+    def geoid(self, value):
+        self._geoid = value
+
+    @property
+    def fips_code(self):
+        return self._fips_code
+
+    @fips_code.setter
+    def fips_code(self, value):
+        self._fips_code = value
+
+    @property
+    def county_name(self):
+        return self._county_name
+
+    @county_name.setter
+    def county_name(self, value):
+        self._county_name = value
+
+    @property
+    def state_name(self):
+        return self._state_name
+
+    @state_name.setter
+    def state_name(self, value):
+        self._state_name = value
+
+    @property
+    def stroke_color(self):
+        return self._stroke_color
+
+    @stroke_color.setter
+    def stroke_color(self, value):
+        self._stroke_color = value
+
+    @property
+    def stroke_width(self):
+        return self._stroke_width
+
+    @stroke_width.setter
+    def stroke_width(self, value):
+        self._stroke_width = value
+
+    @property
+    def fill_color(self):
+        return self._fill_color
+
+    @fill_color.setter
+    def fill_color(self, value):
+        self._fill_color = value
+
+    @property
+    def hide(self):
+        return self._hide
+
+    @hide.setter
+    def hide(self, value):
+        self._hide = value

{bridges-3.4.4 → bridges-3.4.5.dev1}/bridges/data_src_dependent/data_source.py

@@ -2,6 +2,7 @@ import json
 import requests
 import pickle
 import urllib.parse
+import os
 
 from bridges.data_src_dependent.earthquake_usgs import *
 from bridges.data_src_dependent import actor_movie_imdb
@@ -21,10 +22,13 @@ from bridges.data_src_dependent.amenity import *
 from bridges.data_src_dependent.actor_movie_imdb import *
 from bridges.color_grid import ColorGrid
 from bridges.color import Color
+from bridges.data_src_dependent.state import *
+from bridges.data_src_dependent.county import *
 from SPARQLWrapper import SPARQLWrapper, JSON
 
 
 source_type = "live"
+_debug = False
 
 def set_source_type(t) -> None:
     global source_type
@@ -83,6 +87,8 @@ def get_game_data():
     url = "http://bridgesdata.herokuapp.com/api/games"
     PARAMS = {"Accept: application/json"}
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url=url, params=str(PARAMS))
 
     r = r.json()
@@ -206,7 +212,8 @@ def get_world_cities_data(**kwargs) -> List[City]:
             url = url + 'limit=' + str(kwargs['limit']) + '&'
     url = url[:-1]  # remove last &
 
-    print(url)
+    if _debug:
+        print(url)
     PARAMS = {"Accept: application/json"}
 
     r = requests.get(url=url, params=str(PARAMS))
@@ -222,6 +229,36 @@ def get_world_cities_data(**kwargs) -> List[City]:
     return wrapper
 
 
+def get_map(state_name = []):
+
+    wrapper = []
+
+    url = "http://bridgesdata.herokuapp.com/api/us_map?state="
+    for i in range(len(state_name)):
+        url += state_name[i] + ","
+    url = url[:-1]
+    PARAMS = {"Accept: application/json"}
+
+    if _debug:
+        print ("Accessing "+url)
+    r = requests.get(url = url, params = str(PARAMS))
+
+    r = r.json()
+
+    state_info = r['data']
+
+    for i in range(len(state_info)):
+        temp_state = State(state_info[i]['_id']["input"])
+        for j in range(len(state_info[i]['counties'])):
+            current_county = state_info[i]['counties'][j]
+            temp_state.counties.append(County(current_county['properties']['GEOID'],
+                                              current_county['properties']['FIPS_CODE'],
+                                              current_county['properties']['COUNTY_STATE_CODE'],
+                                              current_county['properties']['COUNTY_STATE_NAME']))
+        wrapper.append(temp_state)
+
+    return wrapper
+
 
 
 def _parse_actor_movie_imdb(item) -> ActorMovieIMDB:
@@ -255,8 +292,11 @@ def get_actor_movie_imdb_data(count = 0) -> ActorMovieIMDB:
     wrapper = []
 
     url = "http://bridgesdata.herokuapp.com/api/imdb?limit=" + str(count)
+    if _debug:
+        print ("accessing "+url)
     PARAMS = {"Accept: application/json"}
 
+    
     r = requests.get(url=url, params=str(PARAMS))
     # print(r.status_code, r.reason)
 
@@ -284,7 +324,9 @@ def get_actor_movie_imdb_data2() -> List[ActorMovieIMDB]:
         Exception if the request fails
     """
     url = "https://bridgesdata.herokuapp.com/api/imdb2"
-
+    if _debug:
+        print ("Accessing "+url)
+    
     r = requests.get(url = url)
     status = r.status_code
 
@@ -330,6 +372,8 @@ def get_earthquake_usgs_data(count = 0) -> List[EarthquakeUSGS]:
     PARAMS = {"Accept: application/json"}
 
     if count <= 0:
+        if _debug:
+            print ("Accessing: "+url)
         r = requests.get(url=url, params=str(PARAMS))
         r = r.json()
         for i in range(len(r)):
@@ -337,6 +381,8 @@ def get_earthquake_usgs_data(count = 0) -> List[EarthquakeUSGS]:
             G = r[i]["geometry"]["coordinates"]
             wrapper.append(EarthquakeUSGS(V["mag"], G[0], G[1], V["place"], V["title"], V["url"], V["time"]))
     else:
+        if _debug:
+            print ("Accessing: "+url)
         r = requests.get(url=latest_url, params=str(PARAMS))
         data = r.json()
         D = data["Earthquakes"]
@@ -377,6 +423,8 @@ def get_shakespeare_data(endpoint = "", textonly = False) -> List[Shakespeare]:
     if textonly:
         url += "?format=simple"
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url = url, params = str(PARAMS))
     r = r.json()
 
@@ -409,6 +457,8 @@ def get_gutenberg_book_data(num = 0) -> List[GutenbergBook]:
     if num > 0:
         url += "?limit=" + str(num)
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url=url, params = str(PARAMS))
     r = r.json()
 
@@ -460,6 +510,8 @@ def get_cancer_incident_data(num = 0) -> List[CancerIncidence]:
     if num > 0:
         url += "?limit="+str(num)
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url=url, params=str(PARAMS))
     r = r.json()
 
@@ -525,6 +577,8 @@ def get_song(songTitle, artistName = None) -> Song:
         if len(artistName):
             url += "?artistName=" + urllib.parse.quote(artistName)
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url = url, params = str(PARAMS))
     if r.status_code != 200:
         raise ConnectionError("HTTP Request Failed. Error Code: " + str(r.status_code) + " when accessing "+url)
@@ -574,6 +628,8 @@ def get_song_data() -> List[Song]:
     url = "http://bridgesdata.herokuapp.com/api/songs/"
     params = {"Accept: application/json"}
 
+    if _debug:
+        print ("Accessing "+url)
     r = requests.get(url=url, params=str(params))
     r = r.json()
 
@@ -734,6 +790,8 @@ def _get_assignment(server: str, user: str, assignment: int, subassignment: int
     url = "{}/assignmentJSON/{}.{}/{}".format(server, assignment, subassignment_fixed, user)
     params = "Accept: application/json"
 
+    if _debug:
+        print ("Accessing "+url)
     request = requests.get(url, params)
     if request.ok:
         return request.content
@@ -751,6 +809,8 @@ def _osm_server_request(url):
         url: url for server to process
 
     """
+    if _debug:
+        print ("Accessing "+url)
     request = requests.get(url)
     if not request.ok:
         if request.status_code == 404:
@@ -790,7 +850,6 @@ def get_osm_data(*args) -> OsmData:
     """
     import os
 
-    debug = True
 
     if (len(args) == 2):
         location = args[0]
@@ -810,7 +869,7 @@ def get_osm_data(*args) -> OsmData:
 
     lru = lru_cache.lru_cache(30)
 
-    if debug:
+    if _debug:
         print ("url: "+url)
         print ("hash_url: "+hash_url)
 
@@ -876,6 +935,8 @@ def _server_request(url):
     
     For internal use only
     """
+    if _debug:
+        print ("Requesting "+url)
     request = requests.get(url)
     if not request.ok:
         if request.status_code == 404:
@@ -1157,8 +1218,6 @@ def get_a_gutenberg_book_metadata(id) -> GutenbergMeta:
 
     meta = GutenbergMeta()
     for node in data['book_list']:
-        
-        
         meta.id = node["id"]
         meta.title = node['title']
         meta.lang = node["lang"]
@@ -1245,3 +1304,8 @@ def reddit_data(subreddit, time_request = -9999) -> Reddit:
 
 class DataSource:
     pass
+
+force = os.getenv("FORCE_BRIDGES_DATADEBUG", "")
+if (force != ""):
+    _debug = True
+    

bridges-3.4.5.dev1/bridges/data_src_dependent/state.py

@@ -0,0 +1,61 @@
+
+
+class State:
+
+    def __init__(self, state: str):
+        self._state_name = state
+        self._stroke_color = 'blue'
+        self._counties = []
+        self._view_counties = True
+        self._stroke_width = 0.5
+        self._fill_color = 'blue'
+
+
+    @property
+    def state_name(self):
+        return self._state_name
+
+    @state_name.setter
+    def state_name(self, value):
+        self._state_name = value
+
+    @property
+    def stroke_color(self):
+        return self._stroke_color
+
+    @stroke_color.setter
+    def stroke_color(self, value):
+        self._stroke_color = value
+
+    @property
+    def counties(self):
+        return self._counties
+
+    @counties.setter
+    def counties(self, value):
+        self._counties = value
+
+    @property
+    def view_counties(self):
+        return self._view_counties
+
+    @view_counties.setter
+    def view_counties(self, value):
+        self._view_counties = value
+
+    @property
+    def stroke_width(self):
+        return self._stroke_width
+
+    @stroke_width.setter
+    def stroke_width(self, value):
+        self._stroke_width = value
+
+    @property
+    def fill_color(self):
+        return self._fill_color
+
+    @fill_color.setter
+    def fill_color(self, value):
+        self._fill_color = value
+

{bridges-3.4.4 → bridges-3.4.5.dev1/bridges.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bridges
-Version: 3.4.4
+Version: 3.4.5.dev1
 Summary: Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES
 Home-page: https://github.com/BridgesUNCC/bridges-python
 Author: BRIDGES

{bridges-3.4.4 → bridges-3.4.5.dev1}/bridges.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ bridges/array3d.py
 bridges/audio_channel.py
 bridges/audio_clip.py
 bridges/avl_tree_element.py
+bridges/bar_chart.py
 bridges/bfs_benchmark.py
 bridges/bin_tree_element.py
 bridges/blocking_game.py
@@ -73,6 +74,7 @@ bridges/data_src_dependent/actor_movie_imdb.py
 bridges/data_src_dependent/amenity.py
 bridges/data_src_dependent/cancer_incidence.py
 bridges/data_src_dependent/city.py
+bridges/data_src_dependent/county.py
 bridges/data_src_dependent/data_source.py
 bridges/data_src_dependent/earthquake_usgs.py
 bridges/data_src_dependent/elevation.py
@@ -85,4 +87,5 @@ bridges/data_src_dependent/osm.py
 bridges/data_src_dependent/reddit.py
 bridges/data_src_dependent/shakespeare.py
 bridges/data_src_dependent/song.py
+bridges/data_src_dependent/state.py
 bridges/data_src_dependent/world_cities.py

{bridges-3.4.4 → bridges-3.4.5.dev1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="bridges",
-    version="3.4.4",
+    version="3.4.5.dev1",
     author="BRIDGES",
     author_email="bridges.uncc@gmail.com",
     description="Bridging Real-world Infrastructure Designed to Goal-align, Engage, and Stimulate, an NSF TUES",