guidepost 0.2.9__tar.gz → 0.2.11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. {guidepost-0.2.9/guidepost.egg-info → guidepost-0.2.11}/PKG-INFO +17 -10
  2. {guidepost-0.2.9 → guidepost-0.2.11}/README.md +16 -9
  3. guidepost-0.2.11/guidepost/version.py +2 -0
  4. {guidepost-0.2.9 → guidepost-0.2.11/guidepost.egg-info}/PKG-INFO +17 -10
  5. guidepost-0.2.9/guidepost/version.py +0 -2
  6. {guidepost-0.2.9 → guidepost-0.2.11}/LICENSE +0 -0
  7. {guidepost-0.2.9 → guidepost-0.2.11}/figs/__init__.py +0 -0
  8. {guidepost-0.2.9 → guidepost-0.2.11}/figs/guidepost_tutorial_info.png +0 -0
  9. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost/__init__.py +0 -0
  10. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost/guidepost.js +0 -0
  11. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost/guidepost.py +0 -0
  12. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost.egg-info/SOURCES.txt +0 -0
  13. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost.egg-info/dependency_links.txt +0 -0
  14. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost.egg-info/requires.txt +0 -0
  15. {guidepost-0.2.9 → guidepost-0.2.11}/guidepost.egg-info/top_level.txt +0 -0
  16. {guidepost-0.2.9 → guidepost-0.2.11}/pyproject.toml +0 -0
  17. {guidepost-0.2.9 → guidepost-0.2.11}/setup.cfg +0 -0
  18. {guidepost-0.2.9 → guidepost-0.2.11}/setup.py +0 -0
  19. {guidepost-0.2.9 → guidepost-0.2.11}/tutorials/__init__.py +0 -0
{guidepost-0.2.9/guidepost.egg-info → guidepost-0.2.11}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: guidepost
3
- Version: 0.2.9
3
+ Version: 0.2.11
4
4
  Summary: Guidepost. An overview visualization for understanding supercomputer queue data.
5
5
  Home-page: https://github.com/cscully-allison/guidepost
6
6
  Author: Connor Scully-Allison
@@ -95,13 +95,14 @@ gp.vis_configs = {
95
95
  'facet_by': 'partition'
96
96
  }
97
97
  ```
98
- Configuration Descriptions
99
- `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
100
- `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
101
- `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
102
- `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
103
- `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
104
- `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
98
+ #### Configuration Descriptions:
99
+
100
+ - `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
101
+ - `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
102
+ - `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
103
+ - `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
104
+ - `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
105
+ - `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
105
106
 
106
107
  See the [Vis Configs Section](#vis_configs) for more details on datatype restrictions for each configuration.
107
108
 
@@ -114,10 +115,10 @@ Run the above command in a Jupyter notebook cell to start the visualization.
114
115
 
115
116
  Here is an example of what the viusalization will look like:
116
117
 
117
- ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](figs/guidepost_tutorial_info.png)
118
+ ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](https://i.postimg.cc/vTDMX2b3/temp-Image-MVb5ui.avif)
118
119
 
119
- Here we explain some elements of the visualization:
120
120
 
121
+ Here we explain some elements of the visualization:
121
122
 
122
123
  #### `Data Grouping Name`:
123
124
  This is name of the high level groups which are dictated by the `facet_by` configuration. If your data only logically contains one group, adding a synthetic column is advised and specifying that column name for the `facet_by` cofiguration.
@@ -164,6 +165,12 @@ Below is an example of the kind of data Guidepost works with:
164
165
 
165
166
  ## API Reference
166
167
 
168
+ ### `load_data`
169
+ - **Description**: Loads a pandas dataframe into the guidepost system for visualizaiton. Will report data dropped from the dataframe if it contains NaNs, `timedeltas`, `arrays` in cells, or other invalid values.
170
+ - **Arguments**:
171
+ - `in_df` (Pandas Dataframe): The dataframe containing data to be visualized.
172
+ - `supress_warnings` (Boolean): Specifies whether to suppress warnings when loading data. Defaults to `False`
173
+
167
174
  ### `vis_data`
168
175
  - **Description**: Holds the vis data to passed to the visualization. Updates to this variable will automatically update the visualization.
169
176
 
{guidepost-0.2.9 → guidepost-0.2.11}/README.md RENAMED
@@ -67,13 +67,14 @@ gp.vis_configs = {
67
67
  'facet_by': 'partition'
68
68
  }
69
69
  ```
70
- Configuration Descriptions
71
- `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
72
- `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
73
- `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
74
- `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
75
- `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
76
- `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
70
+ #### Configuration Descriptions:
71
+
72
+ - `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
73
+ - `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
74
+ - `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
75
+ - `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
76
+ - `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
77
+ - `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
77
78
 
78
79
  See the [Vis Configs Section](#vis_configs) for more details on datatype restrictions for each configuration.
79
80
 
@@ -86,10 +87,10 @@ Run the above command in a Jupyter notebook cell to start the visualization.
86
87
 
87
88
  Here is an example of what the viusalization will look like:
88
89
 
89
- ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](figs/guidepost_tutorial_info.png)
90
+ ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](https://i.postimg.cc/vTDMX2b3/temp-Image-MVb5ui.avif)
90
91
 
91
- Here we explain some elements of the visualization:
92
92
 
93
+ Here we explain some elements of the visualization:
93
94
 
94
95
  #### `Data Grouping Name`:
95
96
  This is name of the high level groups which are dictated by the `facet_by` configuration. If your data only logically contains one group, adding a synthetic column is advised and specifying that column name for the `facet_by` cofiguration.
@@ -136,6 +137,12 @@ Below is an example of the kind of data Guidepost works with:
136
137
 
137
138
  ## API Reference
138
139
 
140
+ ### `load_data`
141
+ - **Description**: Loads a pandas dataframe into the guidepost system for visualizaiton. Will report data dropped from the dataframe if it contains NaNs, `timedeltas`, `arrays` in cells, or other invalid values.
142
+ - **Arguments**:
143
+ - `in_df` (Pandas Dataframe): The dataframe containing data to be visualized.
144
+ - `supress_warnings` (Boolean): Specifies whether to suppress warnings when loading data. Defaults to `False`
145
+
139
146
  ### `vis_data`
140
147
  - **Description**: Holds the vis data to passed to the visualization. Updates to this variable will automatically update the visualization.
141
148
 
guidepost-0.2.11/guidepost/version.py ADDED
@@ -0,0 +1,2 @@
1
+ __version_info__ = ("0", "2", "11")
2
+ __version__ = ".".join(__version_info__)
{guidepost-0.2.9 → guidepost-0.2.11/guidepost.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: guidepost
3
- Version: 0.2.9
3
+ Version: 0.2.11
4
4
  Summary: Guidepost. An overview visualization for understanding supercomputer queue data.
5
5
  Home-page: https://github.com/cscully-allison/guidepost
6
6
  Author: Connor Scully-Allison
@@ -95,13 +95,14 @@ gp.vis_configs = {
95
95
  'facet_by': 'partition'
96
96
  }
97
97
  ```
98
- Configuration Descriptions
99
- `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
100
- `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
101
- `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
102
- `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
103
- `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
104
- `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
98
+ #### Configuration Descriptions:
99
+
100
+ - `x`: Name of the column in the dataframe which will be shown on the x axis of Guidepost's subcharts.
101
+ - `y`: Name of the column in the dataframe which will be shown on the y axis of Guidepost's subcharts.
102
+ - `color`: Name of the column in the dataframe which will be shown by the darkness of each square's color.
103
+ - `color_agg`: The aggregation method used to determine the color. Can be: 'avg', 'variance', 'std', 'sum', or 'median'
104
+ - `categorical`: Name of the column containing categorical data values which will be shown on a bar chart associated with each group of the data.
105
+ - `facet_by`: Name of the column containing categorical data values which dictate the highest level grouping of the data. Dictates how many sub charts are produced in the visualization.
105
106
 
106
107
  See the [Vis Configs Section](#vis_configs) for more details on datatype restrictions for each configuration.
107
108
 
@@ -114,10 +115,10 @@ Run the above command in a Jupyter notebook cell to start the visualization.
114
115
 
115
116
  Here is an example of what the viusalization will look like:
116
117
 
117
- ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](figs/guidepost_tutorial_info.png)
118
+ ![Image of the guidepost visualization. Annotations label various parts of the visualization: 'Data Grouping Name', 'Color by Categorical Variable', 'Bar Chart (Filter on Click)', 'Current Selection of Records for Export'](https://i.postimg.cc/vTDMX2b3/temp-Image-MVb5ui.avif)
118
119
 
119
- Here we explain some elements of the visualization:
120
120
 
121
+ Here we explain some elements of the visualization:
121
122
 
122
123
  #### `Data Grouping Name`:
123
124
  This is name of the high level groups which are dictated by the `facet_by` configuration. If your data only logically contains one group, adding a synthetic column is advised and specifying that column name for the `facet_by` cofiguration.
@@ -164,6 +165,12 @@ Below is an example of the kind of data Guidepost works with:
164
165
 
165
166
  ## API Reference
166
167
 
168
+ ### `load_data`
169
+ - **Description**: Loads a pandas dataframe into the guidepost system for visualizaiton. Will report data dropped from the dataframe if it contains NaNs, `timedeltas`, `arrays` in cells, or other invalid values.
170
+ - **Arguments**:
171
+ - `in_df` (Pandas Dataframe): The dataframe containing data to be visualized.
172
+ - `supress_warnings` (Boolean): Specifies whether to suppress warnings when loading data. Defaults to `False`
173
+
167
174
  ### `vis_data`
168
175
  - **Description**: Holds the vis data to passed to the visualization. Updates to this variable will automatically update the visualization.
169
176
 
guidepost-0.2.9/guidepost/version.py DELETED
@@ -1,2 +0,0 @@
1
- __version_info__ = ("0", "2", "9")
2
- __version__ = ".".join(__version_info__)
{guidepost-0.2.9 → guidepost-0.2.11}/LICENSE RENAMED
File without changes
{guidepost-0.2.9 → guidepost-0.2.11}/figs/__init__.py RENAMED
File without changes
{guidepost-0.2.9 → guidepost-0.2.11}/pyproject.toml RENAMED
File without changes
{guidepost-0.2.9 → guidepost-0.2.11}/setup.cfg RENAMED
File without changes
{guidepost-0.2.9 → guidepost-0.2.11}/setup.py RENAMED
File without changes