Gui
cibmangotree.gui.main_workflow
¶
Main GUI workflow including all pages.
Functions:
| Name | Description |
|---|---|
gui_main |
Launch the NiceGUI interface with a minimal single screen. |
gui_main(app)
¶
Launch the NiceGUI interface with a minimal single screen.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
App
|
The initialized App instance with storage and suite |
required |
Source code in src/cibmangotree/gui/main_workflow.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | |
cibmangotree.gui.base
¶
Base abstractions for GUI pages using Pydantic and ABC.
This module provides: - GuiPage: Abstract base class for all GUI pages - format_file_size: Utility for human-readable file sizes - present_separator: Utility for displaying separator characters
Classes:
| Name | Description |
|---|---|
GuiPage |
Abstract base class for all GUI pages. |
Functions:
| Name | Description |
|---|---|
format_file_size |
Format file size in human-readable format. |
present_separator |
Format separator/quote character for display. |
GuiPage
¶
Bases: BaseModel, ABC
Abstract base class for all GUI pages.
Provides common page structure and lifecycle using the Template Method
pattern. Subclasses implement render_content() for page-specific UI
while inheriting consistent header/footer rendering.
Exit lifecycle:
- on_exit(): Override to perform cleanup when leaving the page
- requires_exit_confirmation(): Override to trigger confirmation dialog
- get_exit_confirmation_message(): Override to customize confirmation text
Attributes:
| Name | Type | Description |
|---|---|---|
session |
GuiSession
|
Session state container with app context |
route |
str
|
URL route for this page (e.g., "/", "/projects") |
title |
str
|
Page title shown in header |
show_back_button |
bool
|
Whether to show back navigation button |
back_route |
str | None
|
Route to navigate when back button clicked |
back_icon |
str
|
Icon for back button (default: "arrow_back") |
back_text |
str | None
|
Optional text label for back button |
show_footer |
bool
|
Whether to render footer |
Usage
class MyPage(GuiPage):
def __init__(self, session: GuiSession):
super().__init__(
session=session,
route="/my_page",
title="My Page",
show_back_button=True,
back_route="/",
)
def render_content(self) -> None:
with ui.column().classes("items-center"):
ui.label("My page content")
def requires_exit_confirmation(self) -> bool:
return self.session.current_analysis is not None
def on_exit(self) -> None:
self.session.reset_analysis_workflow()
# Register with NiceGUI
@ui.page("/my_page")
def my_page():
page = MyPage(session)
page.render()
Methods:
| Name | Description |
|---|---|
get_exit_confirmation_message |
Override to customize the exit confirmation message. |
go_back |
Navigate to the configured back route. |
go_home |
Navigate to home page. |
navigate_to |
Navigate to another page in the application. |
navigate_to_external |
Navigate to external URL in new tab. |
notify_error |
Show error notification. |
notify_success |
Show success notification. |
notify_warning |
Show warning notification. |
on_exit |
Override to perform cleanup when leaving the page. |
render |
Main rendering method implementing template pattern. |
render_content |
Render page-specific content. |
requires_exit_confirmation |
Override to trigger confirmation dialog before leaving. |
Source code in src/cibmangotree/gui/base.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | |
get_exit_confirmation_message()
¶
Override to customize the exit confirmation message.
Only used when requires_exit_confirmation() returns True.
Source code in src/cibmangotree/gui/base.py
221 222 223 224 225 226 | |
go_back()
¶
Navigate to the configured back route.
Source code in src/cibmangotree/gui/base.py
301 302 303 304 | |
go_home()
¶
Navigate to home page.
Source code in src/cibmangotree/gui/base.py
306 307 308 | |
navigate_to(route)
¶
Navigate to another page in the application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
Target route path (e.g., "/projects", "/new_project") |
required |
Source code in src/cibmangotree/gui/base.py
283 284 285 286 287 288 289 290 | |
navigate_to_external(url)
¶
Navigate to external URL in new tab.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
External URL to open |
required |
Source code in src/cibmangotree/gui/base.py
292 293 294 295 296 297 298 299 | |
notify_error(message)
¶
Show error notification.
Source code in src/cibmangotree/gui/base.py
332 333 334 | |
notify_success(message)
¶
Show success notification.
Source code in src/cibmangotree/gui/base.py
324 325 326 | |
notify_warning(message)
¶
Show warning notification.
Source code in src/cibmangotree/gui/base.py
328 329 330 | |
on_exit()
¶
Override to perform cleanup when leaving the page.
Called after exit confirmation (if any) is accepted, before navigation occurs.
Source code in src/cibmangotree/gui/base.py
206 207 208 209 210 211 212 | |
render()
¶
Main rendering method implementing template pattern.
Call this method from the NiceGUI @ui.page decorator to render the complete page with header, content, and footer.
Lifecycle: 1. Setup colors 2. Render header 3. Render content (abstract - implemented by subclasses) 4. Render footer
Source code in src/cibmangotree/gui/base.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | |
render_content()
abstractmethod
¶
Render page-specific content.
Subclasses MUST implement this method to provide the main page content. This is called automatically by render().
Example
def render_content(self) -> None:
with ui.column().classes("items-center"):
ui.label("Welcome")
ui.button("Click me", on_click=self._handle_click)
Source code in src/cibmangotree/gui/base.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
requires_exit_confirmation()
¶
Override to trigger confirmation dialog before leaving.
Returns True to show confirmation, False to navigate directly.
Source code in src/cibmangotree/gui/base.py
214 215 216 217 218 219 | |
format_file_size(size_bytes)
¶
Format file size in human-readable format.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
int
|
File size in bytes |
required |
Returns:
| Type | Description |
|---|---|
str
|
Formatted string (e.g., "1.5 MB", "3.2 GB") |
Example
format_file_size(1536) '1.5 KB' format_file_size(1048576) '1.0 MB'
Source code in src/cibmangotree/gui/base.py
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | |
present_separator(value)
¶
Format separator/quote character for display.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
Separator character |
required |
Returns:
| Type | Description |
|---|---|
str
|
Human-readable representation |
Example
present_separator("\t") 'Tab' present_separator(",") ', (Comma)'
Source code in src/cibmangotree/gui/base.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | |
cibmangotree.gui.context
¶
GUI context - similar to ViewContext but for NiceGUI.
Classes:
| Name | Description |
|---|---|
GUIContext |
Context for GUI mode, wrapping the App instance. |
GUIContext
¶
Bases: BaseModel
Context for GUI mode, wrapping the App instance.
Source code in src/cibmangotree/gui/context.py
10 11 12 13 14 | |
cibmangotree.gui.session
¶
Classes:
| Name | Description |
|---|---|
GuiSession |
Application-wide session state container. |
GuiSession
¶
Bases: BaseModel
Application-wide session state container.
Replaces module-level global variables with a type-safe, validated state container. Provides access to application context and workflow state.
Attributes:
| Name | Type | Description |
|---|---|---|
context |
GUIContext
|
Application context wrapping App instance |
current_project |
ProjectContext | None
|
Currently selected/active project |
selected_file_path |
Path | None
|
Path to file selected for import |
new_project_name |
str | None
|
Name for project being created |
import_session |
ImporterSession | None
|
Active importer session for data preview |
selected_analyzer |
AnalyzerInterface | None
|
ID of selected primary analyzer |
current_analysis |
AnalysisModel | None
|
Currently selected/active analysis |
project_loaded_from_storage |
bool
|
True if project was loaded from disk |
analysis_loaded_from_storage |
bool
|
True if analysis was loaded from disk |
Example
context = GUIContext(app=app)
session = GuiSession(context=context)
# Set project
session.current_project = project
# Access app
projects = session.app.list_projects()
Methods:
| Name | Description |
|---|---|
reset_analysis_workflow |
Clear analysis workflow state. |
reset_project_workflow |
Clear project creation workflow state. |
validate_file_selected |
Check if a file is currently selected. |
validate_project_name_set |
Check if new project name is set. |
validate_project_selected |
Check if a project is currently selected. |
Source code in src/cibmangotree/gui/session.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | |
app
property
¶
Access underlying App instance.
reset_analysis_workflow()
¶
Clear analysis workflow state.
Source code in src/cibmangotree/gui/session.py
89 90 91 92 93 94 95 96 | |
reset_project_workflow()
¶
Clear project creation workflow state.
Source code in src/cibmangotree/gui/session.py
78 79 80 81 82 83 84 85 86 87 | |
validate_file_selected()
¶
Check if a file is currently selected.
Source code in src/cibmangotree/gui/session.py
102 103 104 | |
validate_project_name_set()
¶
Check if new project name is set.
Source code in src/cibmangotree/gui/session.py
106 107 108 | |
validate_project_selected()
¶
Check if a project is currently selected.
Source code in src/cibmangotree/gui/session.py
98 99 100 | |
cibmangotree.gui.routes
¶
Classes:
| Name | Description |
|---|---|
GuiRoutes |
Container for |
GuiRoutes
¶
Bases: BaseModel
Container for
Source code in src/cibmangotree/gui/routes.py
4 5 6 7 8 9 10 11 12 13 14 15 16 | |
cibmangotree.gui.theme
¶
Classes:
| Name | Description |
|---|---|
GuiColors |
Mango Tree brand colors |
GuiConstants |
Container for both colors and urls |
GuiURLS |
UI URL constants. |
GuiColors
¶
Bases: BaseModel
Mango Tree brand colors
Source code in src/cibmangotree/gui/theme.py
9 10 11 12 13 14 15 16 17 18 19 | |
GuiConstants
¶
Bases: BaseModel
Container for both colors and urls
Source code in src/cibmangotree/gui/theme.py
43 44 45 46 47 48 49 | |
GuiURLS
¶
Bases: BaseModel
UI URL constants.
Source code in src/cibmangotree/gui/theme.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | |
cibmangotree.gui.components
¶
Modules:
| Name | Description |
|---|---|
analysis |
|
exit_confirmation |
|
export_outputs |
|
import_options |
Import options dialog for modifying CSV/Excel import configuration. |
manage_analyses |
|
manage_projects |
|
stepper_steps |
|
toggle |
|
Classes:
| Name | Description |
|---|---|
AnalysisParamsCard |
Card component for configuring analyzer parameters. |
ExitConfirmationDialog |
Reusable confirmation dialog for page exit navigation. |
ExportDialog |
Multi-step dialog for selecting and exporting analysis outputs. |
ImportOptionsDialog |
Dialog for configuring CSV/Excel import options. |
ManageAnalysisDialog |
Dialog for managing analyses (view and delete). |
ManageProjectsDialog |
Dialog for managing projects (view and delete). |
ToggleButton |
|
ToggleButtonGroup |
Manages a group of toggle buttons with mutual exclusivity. |
AnalysisParamsCard
¶
Card component for configuring analyzer parameters.
Displays each parameter as an individual card, matching the visual style of the column picker cards for consistent UX.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the analysis parameters card. |
get_param_values |
Retrieve current parameter values from the UI controls. |
Source code in src/cibmangotree/gui/components/analysis.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | |
__init__(params, default_values)
¶
Initialize the analysis parameters card.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
list[AnalyzerParam]
|
List of analyzer parameter specifications |
required |
|
dict[str, ParamValue]
|
Dictionary of default parameter values |
required |
Source code in src/cibmangotree/gui/components/analysis.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | |
get_param_values()
¶
Retrieve current parameter values from the UI controls.
Returns:
| Type | Description |
|---|---|
dict[str, ParamValue]
|
Dictionary mapping parameter IDs to their values |
Source code in src/cibmangotree/gui/components/analysis.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | |
ExitConfirmationDialog
¶
Bases: dialog
Reusable confirmation dialog for page exit navigation.
Subclasses ui.dialog to match the pattern used by ManageProjectsDialog and ImportOptionsDialog.
Usage
dialog = ExitConfirmationDialog( message="You have unsaved changes. Leave anyway?", confirm_text="Leave", cancel_text="Stay" ) confirmed = await dialog if confirmed: ui.navigate.to("/home")
Source code in src/cibmangotree/gui/components/exit_confirmation.py
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | |
ExportDialog
¶
Bases: dialog
Multi-step dialog for selecting and exporting analysis outputs.
Source code in src/cibmangotree/gui/components/export_outputs.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
ImportOptionsDialog
¶
Bases: dialog
Dialog for configuring CSV/Excel import options.
Displays interactive controls for modifying import parameters and allows retrying the import with updated settings.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the import options dialog. |
Source code in src/cibmangotree/gui/components/import_options.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
__init__(import_session, selected_file, on_retry)
¶
Initialize the import options dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
CsvImportSession | ExcelImportSession
|
Current import session with detected settings |
required |
|
BytesIO
|
BytesIO buffer of the file being imported |
required |
|
Callable[[CsvImportSession | ExcelImportSession], None]
|
Callback function called when user clicks "Retry Import" with the updated import session as parameter |
required |
Source code in src/cibmangotree/gui/components/import_options.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
ManageAnalysisDialog
¶
Bases: dialog
Dialog for managing analyses (view and delete).
Displays a list of analyses for the current project in a grid and allows users to select and delete one or more analyses.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the Manage Analysis dialog. |
Source code in src/cibmangotree/gui/components/manage_analyses.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | |
__init__(session)
¶
Initialize the Manage Analysis dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GUI session containing app context and state |
required |
Source code in src/cibmangotree/gui/components/manage_analyses.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | |
ManageProjectsDialog
¶
Bases: dialog
Dialog for managing projects (view and delete).
Displays a list of projects in a grid and allows users to select and delete projects.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the Manage Projects dialog. |
Source code in src/cibmangotree/gui/components/manage_projects.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
__init__(session)
¶
Initialize the Manage Projects dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GUI session containing app context and state |
required |
Source code in src/cibmangotree/gui/components/manage_projects.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | |
ToggleButton
¶
Bases: button
Methods:
| Name | Description |
|---|---|
set_active |
Set the button state externally. |
toggle |
Toggle the button state. |
Source code in src/cibmangotree/gui/components/toggle.py
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | |
set_active(active)
¶
Set the button state externally.
Source code in src/cibmangotree/gui/components/toggle.py
23 24 25 26 | |
toggle()
¶
Toggle the button state.
Source code in src/cibmangotree/gui/components/toggle.py
18 19 20 21 | |
ToggleButtonGroup
¶
Manages a group of toggle buttons with mutual exclusivity.
Methods:
| Name | Description |
|---|---|
add_button |
Add a button to the group. |
get_selected |
Get the currently selected button. |
get_selected_text |
Get the text of the currently selected button. |
select |
Select a button, deselecting all others. |
Source code in src/cibmangotree/gui/components/toggle.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
add_button(text, **kwargs)
¶
Add a button to the group.
Source code in src/cibmangotree/gui/components/toggle.py
46 47 48 49 50 | |
get_selected()
¶
Get the currently selected button.
Source code in src/cibmangotree/gui/components/toggle.py
60 61 62 | |
get_selected_text()
¶
Get the text of the currently selected button.
Source code in src/cibmangotree/gui/components/toggle.py
64 65 66 | |
select(button)
¶
Select a button, deselecting all others.
Source code in src/cibmangotree/gui/components/toggle.py
52 53 54 55 56 57 58 | |
analysis
¶
Classes:
| Name | Description |
|---|---|
AnalysisParamsCard |
Card component for configuring analyzer parameters. |
AnalysisParamsCard
¶
Card component for configuring analyzer parameters.
Displays each parameter as an individual card, matching the visual style of the column picker cards for consistent UX.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the analysis parameters card. |
get_param_values |
Retrieve current parameter values from the UI controls. |
Source code in src/cibmangotree/gui/components/analysis.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | |
__init__(params, default_values)
¶
Initialize the analysis parameters card.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
list[AnalyzerParam]
|
List of analyzer parameter specifications |
required |
|
dict[str, ParamValue]
|
Dictionary of default parameter values |
required |
Source code in src/cibmangotree/gui/components/analysis.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | |
get_param_values()
¶
Retrieve current parameter values from the UI controls.
Returns:
| Type | Description |
|---|---|
dict[str, ParamValue]
|
Dictionary mapping parameter IDs to their values |
Source code in src/cibmangotree/gui/components/analysis.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | |
exit_confirmation
¶
Classes:
| Name | Description |
|---|---|
ExitConfirmationDialog |
Reusable confirmation dialog for page exit navigation. |
ExitConfirmationDialog
¶
Bases: dialog
Reusable confirmation dialog for page exit navigation.
Subclasses ui.dialog to match the pattern used by ManageProjectsDialog and ImportOptionsDialog.
Usage
dialog = ExitConfirmationDialog( message="You have unsaved changes. Leave anyway?", confirm_text="Leave", cancel_text="Stay" ) confirmed = await dialog if confirmed: ui.navigate.to("/home")
Source code in src/cibmangotree/gui/components/exit_confirmation.py
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | |
export_outputs
¶
Classes:
| Name | Description |
|---|---|
ExportDialog |
Multi-step dialog for selecting and exporting analysis outputs. |
ExportDialog
¶
Bases: dialog
Multi-step dialog for selecting and exporting analysis outputs.
Source code in src/cibmangotree/gui/components/export_outputs.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
import_options
¶
Import options dialog for modifying CSV/Excel import configuration.
Allows users to adjust import settings and retry preview with updated parameters.
Classes:
| Name | Description |
|---|---|
ImportOptionsDialog |
Dialog for configuring CSV/Excel import options. |
ImportOptionsDialog
¶
Bases: dialog
Dialog for configuring CSV/Excel import options.
Displays interactive controls for modifying import parameters and allows retrying the import with updated settings.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the import options dialog. |
Source code in src/cibmangotree/gui/components/import_options.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
__init__(import_session, selected_file, on_retry)
¶
Initialize the import options dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
CsvImportSession | ExcelImportSession
|
Current import session with detected settings |
required |
|
BytesIO
|
BytesIO buffer of the file being imported |
required |
|
Callable[[CsvImportSession | ExcelImportSession], None]
|
Callback function called when user clicks "Retry Import" with the updated import session as parameter |
required |
Source code in src/cibmangotree/gui/components/import_options.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
manage_analyses
¶
Classes:
| Name | Description |
|---|---|
ManageAnalysisDialog |
Dialog for managing analyses (view and delete). |
ManageAnalysisDialog
¶
Bases: dialog
Dialog for managing analyses (view and delete).
Displays a list of analyses for the current project in a grid and allows users to select and delete one or more analyses.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the Manage Analysis dialog. |
Source code in src/cibmangotree/gui/components/manage_analyses.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | |
__init__(session)
¶
Initialize the Manage Analysis dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GUI session containing app context and state |
required |
Source code in src/cibmangotree/gui/components/manage_analyses.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | |
manage_projects
¶
Classes:
| Name | Description |
|---|---|
ManageProjectsDialog |
Dialog for managing projects (view and delete). |
ManageProjectsDialog
¶
Bases: dialog
Dialog for managing projects (view and delete).
Displays a list of projects in a grid and allows users to select and delete projects.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize the Manage Projects dialog. |
Source code in src/cibmangotree/gui/components/manage_projects.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
__init__(session)
¶
Initialize the Manage Projects dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GUI session containing app context and state |
required |
Source code in src/cibmangotree/gui/components/manage_projects.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | |
stepper_steps
¶
Modules:
| Name | Description |
|---|---|
analyzer_step |
|
column_mapping_step |
|
params_step |
|
run_step |
|
Classes:
| Name | Description |
|---|---|
AnalyzerSelectionStep |
Step 1: Select analyzer from available options. |
ColumnMappingStep |
Step 2: Map user columns to analyzer input columns. |
ParamsConfigStep |
Step 3: Configure analyzer parameters. |
RunAnalysisStep |
Step 4: Execute the analysis with progress tracking. |
AnalyzerSelectionStep
¶
Step 1: Select analyzer from available options.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if an analyzer is selected. |
render |
Render the step content. |
save_state |
Save selection to session. Returns True if successful. |
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
is_valid()
¶
Check if an analyzer is selected.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
53 54 55 56 57 58 | |
render()
¶
Render the step content.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
save_state()
¶
Save selection to session. Returns True if successful.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
ColumnMappingStep
¶
Step 2: Map user columns to analyzer input columns.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all required columns are mapped. |
render |
Render the step content with column cards and preview. |
save_state |
Save column mapping to session. |
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
is_valid()
¶
Check if all required columns are mapped.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
render()
¶
Render the step content with column cards and preview.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
save_state()
¶
Save column mapping to session.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
169 170 171 172 173 174 175 176 177 | |
ParamsConfigStep
¶
Step 3: Configure analyzer parameters.
Methods:
| Name | Description |
|---|---|
has_params |
Check if analyzer has configurable parameters. |
is_valid |
Always valid - params are optional. |
render |
Render parameter configuration or 'no params' message. |
save_state |
Save params to session. |
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
has_params()
¶
Check if analyzer has configurable parameters.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
106 107 108 109 | |
is_valid()
¶
Always valid - params are optional.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
94 95 96 | |
render()
¶
Render parameter configuration or 'no params' message.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
save_state()
¶
Save params to session.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
98 99 100 101 102 103 104 | |
RunAnalysisStep
¶
Step 4: Execute the analysis with progress tracking.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all prerequisites are configured. |
render |
Render the run analysis button and summary. |
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
is_valid()
¶
Check if all prerequisites are configured.
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
65 66 67 68 69 70 71 | |
render()
¶
Render the run analysis button and summary.
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
analyzer_step
¶
Classes:
| Name | Description |
|---|---|
AnalyzerSelectionStep |
Step 1: Select analyzer from available options. |
AnalyzerSelectionStep
¶
Step 1: Select analyzer from available options.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if an analyzer is selected. |
render |
Render the step content. |
save_state |
Save selection to session. Returns True if successful. |
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
is_valid()
¶
Check if an analyzer is selected.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
53 54 55 56 57 58 | |
render()
¶
Render the step content.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
save_state()
¶
Save selection to session. Returns True if successful.
Source code in src/cibmangotree/gui/components/stepper_steps/analyzer_step.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
column_mapping_step
¶
Classes:
| Name | Description |
|---|---|
ColumnMappingStep |
Step 2: Map user columns to analyzer input columns. |
ColumnMappingStep
¶
Step 2: Map user columns to analyzer input columns.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all required columns are mapped. |
render |
Render the step content with column cards and preview. |
save_state |
Save column mapping to session. |
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
is_valid()
¶
Check if all required columns are mapped.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
render()
¶
Render the step content with column cards and preview.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
save_state()
¶
Save column mapping to session.
Source code in src/cibmangotree/gui/components/stepper_steps/column_mapping_step.py
169 170 171 172 173 174 175 176 177 | |
params_step
¶
Classes:
| Name | Description |
|---|---|
ParamsConfigStep |
Step 3: Configure analyzer parameters. |
ParamsConfigStep
¶
Step 3: Configure analyzer parameters.
Methods:
| Name | Description |
|---|---|
has_params |
Check if analyzer has configurable parameters. |
is_valid |
Always valid - params are optional. |
render |
Render parameter configuration or 'no params' message. |
save_state |
Save params to session. |
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
has_params()
¶
Check if analyzer has configurable parameters.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
106 107 108 109 | |
is_valid()
¶
Always valid - params are optional.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
94 95 96 | |
render()
¶
Render parameter configuration or 'no params' message.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
save_state()
¶
Save params to session.
Source code in src/cibmangotree/gui/components/stepper_steps/params_step.py
98 99 100 101 102 103 104 | |
run_step
¶
Classes:
| Name | Description |
|---|---|
RunAnalysisStep |
Step 4: Execute the analysis with progress tracking. |
RunAnalysisStep
¶
Step 4: Execute the analysis with progress tracking.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all prerequisites are configured. |
render |
Render the run analysis button and summary. |
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
is_valid()
¶
Check if all prerequisites are configured.
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
65 66 67 68 69 70 71 | |
render()
¶
Render the run analysis button and summary.
Source code in src/cibmangotree/gui/components/stepper_steps/run_step.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
toggle
¶
Classes:
| Name | Description |
|---|---|
ToggleButton |
|
ToggleButtonGroup |
Manages a group of toggle buttons with mutual exclusivity. |
ToggleButton
¶
Bases: button
Methods:
| Name | Description |
|---|---|
set_active |
Set the button state externally. |
toggle |
Toggle the button state. |
Source code in src/cibmangotree/gui/components/toggle.py
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | |
set_active(active)
¶
Set the button state externally.
Source code in src/cibmangotree/gui/components/toggle.py
23 24 25 26 | |
toggle()
¶
Toggle the button state.
Source code in src/cibmangotree/gui/components/toggle.py
18 19 20 21 | |
ToggleButtonGroup
¶
Manages a group of toggle buttons with mutual exclusivity.
Methods:
| Name | Description |
|---|---|
add_button |
Add a button to the group. |
get_selected |
Get the currently selected button. |
get_selected_text |
Get the text of the currently selected button. |
select |
Select a button, deselecting all others. |
Source code in src/cibmangotree/gui/components/toggle.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
add_button(text, **kwargs)
¶
Add a button to the group.
Source code in src/cibmangotree/gui/components/toggle.py
46 47 48 49 50 | |
get_selected()
¶
Get the currently selected button.
Source code in src/cibmangotree/gui/components/toggle.py
60 61 62 | |
get_selected_text()
¶
Get the text of the currently selected button.
Source code in src/cibmangotree/gui/components/toggle.py
64 65 66 | |
select(button)
¶
Select a button, deselecting all others.
Source code in src/cibmangotree/gui/components/toggle.py
52 53 54 55 56 57 58 | |
cibmangotree.gui.pages
¶
Modules:
| Name | Description |
|---|---|
analysis_config_and_run |
|
analysis_workflow |
|
analyzer_previous |
|
analyzer_select |
|
dataset_preview |
|
importer |
|
project_select |
|
start |
|
Classes:
| Name | Description |
|---|---|
AnalysisConfigAndRunPage |
Combined analysis configuration using a stepper. |
ImportDatasetPage |
Dataset import page for selecting a file. |
PreviewDatasetPage |
Data preview page showing a sample of the imported dataset. |
SelectAnalyzerForkPage |
A forking page with two buttons for either advancing to start a new analysis or selecting an old one |
SelectPreviousAnalyzerPage |
Page for selecting a previous analysis to review. |
SelectProjectPage |
Projects list page showing existing projects. |
StartPage |
Main/home page of the application. |
AnalysisConfigAndRunPage
¶
Bases: GuiPage
Combined analysis configuration using a stepper.
Methods:
| Name | Description |
|---|---|
render_content |
Render the stepper with all configuration steps. |
Source code in src/cibmangotree/gui/pages/analysis_config_and_run.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
render_content()
¶
Render the stepper with all configuration steps.
Source code in src/cibmangotree/gui/pages/analysis_config_and_run.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
ImportDatasetPage
¶
Bases: GuiPage
Dataset import page for selecting a file.
Allows users to: 1. Browse for CSV/Excel files 2. View file information 3. Proceed to data preview
Methods:
| Name | Description |
|---|---|
render_content |
Render file selection interface. |
Source code in src/cibmangotree/gui/pages/importer.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
render_content()
¶
Render file selection interface.
Source code in src/cibmangotree/gui/pages/importer.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
PreviewDatasetPage
¶
Bases: GuiPage
Data preview page showing a sample of the imported dataset.
Allows users to: 1. View first 5 rows of data with column info 2. Adjust import options (delimiter, encoding, etc.) 3. Confirm and create project with imported data
Source code in src/cibmangotree/gui/pages/dataset_preview.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
SelectAnalyzerForkPage
¶
Bases: GuiPage
A forking page with two buttons for either advancing to start a new analysis or selecting an old one
Source code in src/cibmangotree/gui/pages/analyzer_select.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | |
SelectPreviousAnalyzerPage
¶
Bases: GuiPage
Page for selecting a previous analysis to review.
Methods:
| Name | Description |
|---|---|
render_content |
Render previous analysis selection interface. |
Source code in src/cibmangotree/gui/pages/analyzer_previous.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | |
render_content()
¶
Render previous analysis selection interface.
Source code in src/cibmangotree/gui/pages/analyzer_previous.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
SelectProjectPage
¶
Bases: GuiPage
Projects list page showing existing projects.
Allows users to select an existing project to work with.
Methods:
| Name | Description |
|---|---|
render_content |
Render projects list with selection interface. |
Source code in src/cibmangotree/gui/pages/project_select.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
render_content()
¶
Render projects list with selection interface.
Source code in src/cibmangotree/gui/pages/project_select.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
StartPage
¶
Bases: GuiPage
Main/home page of the application.
Displays welcome message and primary navigation buttons for creating a new project or viewing existing projects.
Methods:
| Name | Description |
|---|---|
render_content |
Render main page content with action buttons. |
Source code in src/cibmangotree/gui/pages/start.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | |
render_content()
¶
Render main page content with action buttons.
Source code in src/cibmangotree/gui/pages/start.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | |
analysis_config_and_run
¶
Classes:
| Name | Description |
|---|---|
AnalysisConfigAndRunPage |
Combined analysis configuration using a stepper. |
AnalysisConfigAndRunPage
¶
Bases: GuiPage
Combined analysis configuration using a stepper.
Methods:
| Name | Description |
|---|---|
render_content |
Render the stepper with all configuration steps. |
Source code in src/cibmangotree/gui/pages/analysis_config_and_run.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
render_content()
¶
Render the stepper with all configuration steps.
Source code in src/cibmangotree/gui/pages/analysis_config_and_run.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
analysis_workflow
¶
Modules:
| Name | Description |
|---|---|
analyzer_step |
|
column_mapping_step |
|
params_step |
|
run_step |
|
Classes:
| Name | Description |
|---|---|
AnalyzerSelectionStep |
Step 1: Select analyzer from available options. |
ColumnMappingStep |
Step 2: Map user columns to analyzer input columns. |
ParamsConfigStep |
Step 3: Configure analyzer parameters. |
RunAnalysisStep |
Step 4: Execute the analysis with progress tracking. |
AnalyzerSelectionStep
¶
Step 1: Select analyzer from available options.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if an analyzer is selected. |
render |
Render the step content. |
save_state |
Save selection to session. Returns True if successful. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
is_valid()
¶
Check if an analyzer is selected.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
53 54 55 56 57 58 | |
render()
¶
Render the step content.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
save_state()
¶
Save selection to session. Returns True if successful.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
ColumnMappingStep
¶
Step 2: Map user columns to analyzer input columns.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all required columns are mapped. |
render |
Render the step content with column cards and preview. |
save_state |
Save column mapping to session. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
is_valid()
¶
Check if all required columns are mapped.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
render()
¶
Render the step content with column cards and preview.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
save_state()
¶
Save column mapping to session.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
169 170 171 172 173 174 175 176 177 | |
ParamsConfigStep
¶
Step 3: Configure analyzer parameters.
Methods:
| Name | Description |
|---|---|
has_params |
Check if analyzer has configurable parameters. |
is_valid |
Always valid - params are optional. |
render |
Render parameter configuration or 'no params' message. |
save_state |
Save params to session. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
has_params()
¶
Check if analyzer has configurable parameters.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
106 107 108 109 | |
is_valid()
¶
Always valid - params are optional.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
94 95 96 | |
render()
¶
Render parameter configuration or 'no params' message.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
save_state()
¶
Save params to session.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
98 99 100 101 102 103 104 | |
RunAnalysisStep
¶
Step 4: Execute the analysis with progress tracking.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all prerequisites are configured. |
render |
Render the run analysis button and summary. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
is_valid()
¶
Check if all prerequisites are configured.
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
65 66 67 68 69 70 71 | |
render()
¶
Render the run analysis button and summary.
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
analyzer_step
¶
Classes:
| Name | Description |
|---|---|
AnalyzerSelectionStep |
Step 1: Select analyzer from available options. |
AnalyzerSelectionStep
¶
Step 1: Select analyzer from available options.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if an analyzer is selected. |
render |
Render the step content. |
save_state |
Save selection to session. Returns True if successful. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
is_valid()
¶
Check if an analyzer is selected.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
53 54 55 56 57 58 | |
render()
¶
Render the step content.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
save_state()
¶
Save selection to session. Returns True if successful.
Source code in src/cibmangotree/gui/pages/analysis_workflow/analyzer_step.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
column_mapping_step
¶
Classes:
| Name | Description |
|---|---|
ColumnMappingStep |
Step 2: Map user columns to analyzer input columns. |
ColumnMappingStep
¶
Step 2: Map user columns to analyzer input columns.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all required columns are mapped. |
render |
Render the step content with column cards and preview. |
save_state |
Save column mapping to session. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
is_valid()
¶
Check if all required columns are mapped.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
render()
¶
Render the step content with column cards and preview.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
save_state()
¶
Save column mapping to session.
Source code in src/cibmangotree/gui/pages/analysis_workflow/column_mapping_step.py
169 170 171 172 173 174 175 176 177 | |
params_step
¶
Classes:
| Name | Description |
|---|---|
ParamsConfigStep |
Step 3: Configure analyzer parameters. |
ParamsConfigStep
¶
Step 3: Configure analyzer parameters.
Methods:
| Name | Description |
|---|---|
has_params |
Check if analyzer has configurable parameters. |
is_valid |
Always valid - params are optional. |
render |
Render parameter configuration or 'no params' message. |
save_state |
Save params to session. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
has_params()
¶
Check if analyzer has configurable parameters.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
106 107 108 109 | |
is_valid()
¶
Always valid - params are optional.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
94 95 96 | |
render()
¶
Render parameter configuration or 'no params' message.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
save_state()
¶
Save params to session.
Source code in src/cibmangotree/gui/pages/analysis_workflow/params_step.py
98 99 100 101 102 103 104 | |
run_step
¶
Classes:
| Name | Description |
|---|---|
RunAnalysisStep |
Step 4: Execute the analysis with progress tracking. |
RunAnalysisStep
¶
Step 4: Execute the analysis with progress tracking.
Methods:
| Name | Description |
|---|---|
is_valid |
Check if all prerequisites are configured. |
render |
Render the run analysis button and summary. |
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
is_valid()
¶
Check if all prerequisites are configured.
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
65 66 67 68 69 70 71 | |
render()
¶
Render the run analysis button and summary.
Source code in src/cibmangotree/gui/pages/analysis_workflow/run_step.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
analyzer_previous
¶
Classes:
| Name | Description |
|---|---|
SelectPreviousAnalyzerPage |
Page for selecting a previous analysis to review. |
SelectPreviousAnalyzerPage
¶
Bases: GuiPage
Page for selecting a previous analysis to review.
Methods:
| Name | Description |
|---|---|
render_content |
Render previous analysis selection interface. |
Source code in src/cibmangotree/gui/pages/analyzer_previous.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | |
render_content()
¶
Render previous analysis selection interface.
Source code in src/cibmangotree/gui/pages/analyzer_previous.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
analyzer_select
¶
Classes:
| Name | Description |
|---|---|
SelectAnalyzerForkPage |
A forking page with two buttons for either advancing to start a new analysis or selecting an old one |
SelectAnalyzerForkPage
¶
Bases: GuiPage
A forking page with two buttons for either advancing to start a new analysis or selecting an old one
Source code in src/cibmangotree/gui/pages/analyzer_select.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | |
dataset_preview
¶
Classes:
| Name | Description |
|---|---|
PreviewDatasetPage |
Data preview page showing a sample of the imported dataset. |
PreviewDatasetPage
¶
Bases: GuiPage
Data preview page showing a sample of the imported dataset.
Allows users to: 1. View first 5 rows of data with column info 2. Adjust import options (delimiter, encoding, etc.) 3. Confirm and create project with imported data
Source code in src/cibmangotree/gui/pages/dataset_preview.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
importer
¶
Classes:
| Name | Description |
|---|---|
ImportDatasetPage |
Dataset import page for selecting a file. |
ImportDatasetPage
¶
Bases: GuiPage
Dataset import page for selecting a file.
Allows users to: 1. Browse for CSV/Excel files 2. View file information 3. Proceed to data preview
Methods:
| Name | Description |
|---|---|
render_content |
Render file selection interface. |
Source code in src/cibmangotree/gui/pages/importer.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
render_content()
¶
Render file selection interface.
Source code in src/cibmangotree/gui/pages/importer.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
project_select
¶
Classes:
| Name | Description |
|---|---|
SelectProjectPage |
Projects list page showing existing projects. |
SelectProjectPage
¶
Bases: GuiPage
Projects list page showing existing projects.
Allows users to select an existing project to work with.
Methods:
| Name | Description |
|---|---|
render_content |
Render projects list with selection interface. |
Source code in src/cibmangotree/gui/pages/project_select.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
render_content()
¶
Render projects list with selection interface.
Source code in src/cibmangotree/gui/pages/project_select.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
start
¶
Classes:
| Name | Description |
|---|---|
StartPage |
Main/home page of the application. |
StartPage
¶
Bases: GuiPage
Main/home page of the application.
Displays welcome message and primary navigation buttons for creating a new project or viewing existing projects.
Methods:
| Name | Description |
|---|---|
render_content |
Render main page content with action buttons. |
Source code in src/cibmangotree/gui/pages/start.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | |
render_content()
¶
Render main page content with action buttons.
Source code in src/cibmangotree/gui/pages/start.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | |
cibmangotree.gui.dashboards
¶
Dashboard pages for the NiceGUI GUI.
Each analyzer that produces results has a corresponding dashboard module here. All dashboard pages inherit from BaseDashboardPage, which extends GuiPage.
Modules:
| Name | Description |
|---|---|
base_dashboard |
BaseDashboardPage abstract base class |
hashtags |
HashtagsDashboardPage for the hashtags analyzer |
ngrams |
NgramsDashboardPage for the n-grams analyzer |
placeholder |
PlaceholderDashboard shown when no dashboard exists yet |
temporal |
TemporalDashboardPage for the temporal analyzer (planned) |
Classes:
| Name | Description |
|---|---|
BaseDashboardPage |
Abstract base class for all analyzer dashboard pages. |
HashtagsDashboardPage |
Hashtags dashboard with ranked lists instead of bar charts. |
NgramsDashboardPage |
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer. |
PlaceholderDashboard |
Fallback page shown when the selected analyzer has no dashboard yet. |
Functions:
| Name | Description |
|---|---|
get_dashboard |
Look up a registered dashboard class by analyzer ID. |
BaseDashboardPage
¶
Bases: GuiPage, ABC
Abstract base class for all analyzer dashboard pages.
Extends GuiPage with dashboard-specific defaults: - Back button navigates to the post-analysis page - Title is derived from the selected analyzer name - Footer is shown
Subclasses must set _secondary_analyzer_id to enable get_output_parquet_path() for loading analysis results.
Subclasses implement render_content() to provide the actual charts, tables, and interactive controls for each analyzer.
Usage
class NgramsDashboardPage(BaseDashboardPage):
_secondary_analyzer_id = ngram_stats_interface.id
def render_content(self) -> None:
ui.label("N-grams dashboard content here")
Methods:
| Name | Description |
|---|---|
get_output_parquet_path |
Get path to a secondary output parquet file for the current analysis. |
load_parquet_async |
Load a parquet file asynchronously with loading/error handling. |
render_content |
Render dashboard-specific charts, tables, and controls. |
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | |
get_output_parquet_path(output_id)
¶
Get path to a secondary output parquet file for the current analysis.
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
load_parquet_async(output_id, on_success, loading_container=None, content_container=None)
async
¶
Load a parquet file asynchronously with loading/error handling.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
Secondary output identifier to locate the parquet file. |
required |
|
Callable[[DataFrame], None]
|
Callback invoked with the loaded DataFrame on success. |
required |
|
column | None
|
Container to show error in if loading fails. |
None
|
|
column | None
|
Paired content container to reveal on success. |
None
|
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |
render_content()
abstractmethod
¶
Render dashboard-specific charts, tables, and controls.
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
163 164 165 166 | |
HashtagsDashboardPage
¶
Bases: BaseDashboardPage
Hashtags dashboard with ranked lists instead of bar charts.
Dependency chain: Gini plot click -> sets timewindow -> populates hashtag list Hashtag row click -> populates user list User row click -> populates tweet explorer
Source code in src/cibmangotree/gui/dashboards/hashtags/dashboard.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 | |
NgramsDashboardPage
¶
Bases: BaseDashboardPage
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer.
Renders a log-log scatter plot of n-gram frequency versus unique poster count. Each point represents one n-gram; points are coloured by n-gram length.
Interactive features: - Click a point to highlight it and filter the data grid to show all occurrences of that n-gram - Click the same point again to deselect and return to summary view - Click a different point to switch selection
Source code in src/cibmangotree/gui/dashboards/ngrams/dashboard.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
PlaceholderDashboard
¶
Bases: BaseDashboardPage
Fallback page shown when the selected analyzer has no dashboard yet.
Source code in src/cibmangotree/gui/dashboards/placeholder/dashboard.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | |
base_dashboard
¶
Base class for all analyzer dashboard pages.
Provides a standard layout shell for dashboards: - Header inherited from GuiPage (with back-to-results navigation) - A full-width content area for charts and tables - Footer inherited from GuiPage
All analyzer-specific dashboard pages should subclass BaseDashboardPage and implement render_content().
Classes:
| Name | Description |
|---|---|
BaseDashboardPage |
Abstract base class for all analyzer dashboard pages. |
BaseDashboardPage
¶
Bases: GuiPage, ABC
Abstract base class for all analyzer dashboard pages.
Extends GuiPage with dashboard-specific defaults: - Back button navigates to the post-analysis page - Title is derived from the selected analyzer name - Footer is shown
Subclasses must set _secondary_analyzer_id to enable get_output_parquet_path() for loading analysis results.
Subclasses implement render_content() to provide the actual charts, tables, and interactive controls for each analyzer.
Usage
class NgramsDashboardPage(BaseDashboardPage):
_secondary_analyzer_id = ngram_stats_interface.id
def render_content(self) -> None:
ui.label("N-grams dashboard content here")
Methods:
| Name | Description |
|---|---|
get_output_parquet_path |
Get path to a secondary output parquet file for the current analysis. |
load_parquet_async |
Load a parquet file asynchronously with loading/error handling. |
render_content |
Render dashboard-specific charts, tables, and controls. |
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | |
get_output_parquet_path(output_id)
¶
Get path to a secondary output parquet file for the current analysis.
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
load_parquet_async(output_id, on_success, loading_container=None, content_container=None)
async
¶
Load a parquet file asynchronously with loading/error handling.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
Secondary output identifier to locate the parquet file. |
required |
|
Callable[[DataFrame], None]
|
Callback invoked with the loaded DataFrame on success. |
required |
|
column | None
|
Container to show error in if loading fails. |
None
|
|
column | None
|
Paired content container to reveal on success. |
None
|
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |
render_content()
abstractmethod
¶
Render dashboard-specific charts, tables, and controls.
Source code in src/cibmangotree/gui/dashboards/base_dashboard.py
163 164 165 166 | |
get_dashboard(analyzer_id)
¶
Look up a registered dashboard class by analyzer ID.
Source code in src/cibmangotree/gui/dashboards/__init__.py
26 27 28 | |
hashtags
¶
Modules:
| Name | Description |
|---|---|
dashboard |
Hashtags analyzer dashboard page. |
data |
Thin data loading wrappers for the hashtags analyzer. |
plots |
Framework-agnostic ECharts figure builders for the hashtags analyzer. |
Classes:
| Name | Description |
|---|---|
HashtagsDashboardPage |
Hashtags dashboard with ranked lists instead of bar charts. |
HashtagsDashboardPage
¶
Bases: BaseDashboardPage
Hashtags dashboard with ranked lists instead of bar charts.
Dependency chain: Gini plot click -> sets timewindow -> populates hashtag list Hashtag row click -> populates user list User row click -> populates tweet explorer
Source code in src/cibmangotree/gui/dashboards/hashtags/dashboard.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 | |
dashboard
¶
Hashtags analyzer dashboard page.
Layout: - Top: Gini line plot (full width) — click to select time window - Middle-left: Hashtag ranked list (AG-Grid) — click row to select hashtag - Middle-right: User ranked list (AG-Grid) — click row to select user - Bottom: Tweet Explorer (AG-Grid) — shows tweets for selected user/hashtag/window
Classes:
| Name | Description |
|---|---|
HashtagsDashboardPage |
Hashtags dashboard with ranked lists instead of bar charts. |
HashtagsDashboardPage
¶
Bases: BaseDashboardPage
Hashtags dashboard with ranked lists instead of bar charts.
Dependency chain: Gini plot click -> sets timewindow -> populates hashtag list Hashtag row click -> populates user list User row click -> populates tweet explorer
Source code in src/cibmangotree/gui/dashboards/hashtags/dashboard.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 | |
data
¶
Thin data loading wrappers for the hashtags analyzer.
Provides functions to: - Load and transform raw input data (replicates factory.py logic) - Run secondary analysis on-demand from primary output
Functions:
| Name | Description |
|---|---|
extract_users_for_hashtag |
Extract users who posted a specific hashtag from secondary analysis output. |
load_primary_output |
Load primary output parquet and convert timewindow_start to datetime. |
load_transformed_raw_input |
Load raw input dataset and apply analysis preprocessing. |
run_secondary_analysis |
Run secondary analysis for a single timewindow. |
extract_users_for_hashtag(df_secondary, hashtag)
¶
Extract users who posted a specific hashtag from secondary analysis output.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
DataFrame
|
Output of secondary_analyzer() with columns: hashtags, users_all, users_unique, hashtag_perc |
required |
|
str
|
The hashtag to filter by. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with columns: User, Posts (sorted by Posts descending). |
DataFrame
|
Empty DataFrame if hashtag not found. |
Source code in src/cibmangotree/gui/dashboards/hashtags/data.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
load_primary_output(session)
¶
Load primary output parquet and convert timewindow_start to datetime.
The analyzer writes timewindow_start as a string ("%Y-%m-%d %H:%M:%S"). This function reads the parquet and converts it back to datetime for downstream use (charting, secondary analysis).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GuiSession with current_analysis and app context. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with timewindow_start as datetime column. |
Source code in src/cibmangotree/gui/dashboards/hashtags/data.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | |
load_transformed_raw_input(session)
¶
Load raw input dataset and apply analysis preprocessing.
Replicates the logic from hashtags_web/factory.py: 1. Load parquet from storage 2. Apply semantic transforms to time/identifier columns 3. Rename columns via column_mapping 4. Sort by timestamp
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
GuiSession
|
GuiSession with current_analysis and app context. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
Transformed DataFrame with schema columns (e.g., COL_TIME, COL_AUTHOR_ID, COL_POST). |
Source code in src/cibmangotree/gui/dashboards/hashtags/data.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | |
run_secondary_analysis(df_primary, timewindow)
¶
Run secondary analysis for a single timewindow.
Thin wrapper around secondary_analyzer() from the Shiny app.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
DataFrame
|
Primary output DataFrame with timewindow_start column. |
required |
|
datetime
|
The selected timewindow start datetime. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with per-hashtag stats (hashtags, users_all, users_unique, hashtag_perc). |
Source code in src/cibmangotree/gui/dashboards/hashtags/data.py
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
plots
¶
Framework-agnostic ECharts figure builders for the hashtags analyzer.
These functions accept Polars DataFrames and return ECharts option dicts. They have no dependency on Shiny, Dash, or NiceGUI.
Functions:
| Name | Description |
|---|---|
plot_gini_echart |
Build a line chart of Gini coefficient over time. |
plot_gini_echart(df, smooth=False)
¶
Build a line chart of Gini coefficient over time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
DataFrame
|
Primary output DataFrame with 'timewindow_start' and 'gini' columns. |
required |
|
bool
|
Whether to include a smoothed line (requires 'gini_smooth' column). |
False
|
Returns:
| Type | Description |
|---|---|
dict
|
ECharts option dict ready for ui.echart(). |
Source code in src/cibmangotree/gui/dashboards/hashtags/plots.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
ngrams
¶
Modules:
| Name | Description |
|---|---|
dashboard |
N-grams results dashboard page. |
data |
Data loading and transformation helpers for the n-grams dashboard. |
plots |
Framework-agnostic ECharts figure builders for the n-grams analyzer. |
Classes:
| Name | Description |
|---|---|
NgramsDashboardPage |
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer. |
NgramsDashboardPage
¶
Bases: BaseDashboardPage
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer.
Renders a log-log scatter plot of n-gram frequency versus unique poster count. Each point represents one n-gram; points are coloured by n-gram length.
Interactive features: - Click a point to highlight it and filter the data grid to show all occurrences of that n-gram - Click the same point again to deselect and return to summary view - Click a different point to switch selection
Source code in src/cibmangotree/gui/dashboards/ngrams/dashboard.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
dashboard
¶
N-grams results dashboard page.
Displays an interactive scatter plot of n-gram frequency vs. unique poster
count, loaded from the ngram_stats secondary analyzer output. Clicking
a point filters the data grid to show all occurrences of that n-gram.
Classes:
| Name | Description |
|---|---|
NgramsDashboardPage |
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer. |
NgramsDashboardPage
¶
Bases: BaseDashboardPage
Results dashboard for the N-grams (Copy-Pasta Detector) analyzer.
Renders a log-log scatter plot of n-gram frequency versus unique poster count. Each point represents one n-gram; points are coloured by n-gram length.
Interactive features: - Click a point to highlight it and filter the data grid to show all occurrences of that n-gram - Click the same point again to deselect and return to summary view - Click a different point to switch selection
Source code in src/cibmangotree/gui/dashboards/ngrams/dashboard.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
data
¶
Data loading and transformation helpers for the n-grams dashboard.
Provides functions to: - Build summary and detail column definitions for AG-Grid - Filter n-gram stats by text search
plots
¶
Framework-agnostic ECharts figure builders for the n-grams analyzer.
These functions accept a Polars DataFrame and return an ECharts option dict. They have no dependency on Shiny, Dash, or NiceGUI.
Classes:
| Name | Description |
|---|---|
SamplingMetadata |
Metadata about data sampling applied before visualization. |
SamplingMetadata
¶
Bases: BaseModel
Metadata about data sampling applied before visualization.
Source code in src/cibmangotree/gui/dashboards/ngrams/plots.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
placeholder
¶
Modules:
| Name | Description |
|---|---|
dashboard |
Placeholder dashboard shown when an analyzer has no dashboard yet. |
Classes:
| Name | Description |
|---|---|
PlaceholderDashboard |
Fallback page shown when the selected analyzer has no dashboard yet. |
PlaceholderDashboard
¶
Bases: BaseDashboardPage
Fallback page shown when the selected analyzer has no dashboard yet.
Source code in src/cibmangotree/gui/dashboards/placeholder/dashboard.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | |
dashboard
¶
Placeholder dashboard shown when an analyzer has no dashboard yet.
Classes:
| Name | Description |
|---|---|
PlaceholderDashboard |
Fallback page shown when the selected analyzer has no dashboard yet. |
PlaceholderDashboard
¶
Bases: BaseDashboardPage
Fallback page shown when the selected analyzer has no dashboard yet.
Source code in src/cibmangotree/gui/dashboards/placeholder/dashboard.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | |
cibmangotree.gui.utils
¶
Functions:
| Name | Description |
|---|---|
is_wsl |
Check if the environment is WSL2. |
is_wsl()
¶
Check if the environment is WSL2.
Source code in src/cibmangotree/gui/utils.py
6 7 8 9 10 11 12 | |