Readmes

Author: mrvisscher

activity_browser/app/panes/README.md

@@ -22,23 +22,11 @@ Panes inherit from `AbstractPane` (in `ui/widgets/abstract_pane.py`) which provi
 - Signal connections
 - State persistence (dock position, visibility)
 
-## Common Pane Types
-
-### Navigation Panes
-- **Database browser** - Tree view of available databases
-- **Activity browser** - Search and browse activities
-- **Method browser** - Browse impact assessment methods
-- **Project browser** - List of Brightway projects
-
-### Information Panes
-- **Details panel** - Show details of selected items
-- **Properties** - Display item properties and metadata
-- **History** - Recent actions or visited items
-
-### Tool Panes
-- **Quick calculations** - Run simple calculations
-- **Search** - Global search interface
-- **Console** - Python console for advanced users
+## Existing Panes
+- **Databases Pane** - View of available databases
+- **Database Products Pane** - Search and browse product-type nodes within a database
+- **Impact Categories Pane** - Browse impact assessment methods
+- **Calculation Setups Pane** - List of Calculation Setups
 
 ## Pane Features
 
@@ -65,50 +53,16 @@ from activity_browser.ui.widgets import AbstractPane
 class MyPane(AbstractPane):
     def __init__(self, parent=None):
         super().__init__(parent)
-        self.setup_ui()
-        
-    def setup_ui(self):
-        # Build pane content
-        pass
-```
-
-## Integration with Main Window
-
-Panes are added to the main window as dock widgets:
-
-```python
-from activity_browser import app
-
-pane = MyPane()
-app.main_window.addDockWidget(Qt.LeftDockWidgetArea, pane)
-```
-
-## Signal Communication
-
-Panes communicate with other components via signals:
-
-```python
-from activity_browser import app
-
-class MyPane(AbstractPane):
-    def on_item_selected(self, item):
-        # Emit signal for other components
-        app.signals.item_selected.emit(item)
 ```
 
 ## Development Guidelines
 
 When creating new panes:
 
-1. **Inherit from AbstractPane** - Use the base class for consistency
-2. **Set pane title** - Provide a clear, descriptive title
-3. **Keep focused** - Each pane should have a single, clear purpose
-4. **Connect signals** - Listen for and emit relevant signals
-5. **Handle updates** - Refresh when underlying data changes
-6. **Support search/filter** - Allow users to find items quickly
-7. **Provide context menus** - Right-click actions for items
-8. **Make it closeable** - Users should be able to hide panes
-9. **Support keyboard navigation** - Enable keyboard shortcuts
+- **Inherit from AbstractPane** - Use the base class for consistency
+- **Set pane title** - Use the standard `PaneNamePane` naming convention to set the title automatically
+- **Base panes** - Add base panes to `__init__.py` in this directory so they are loaded by the main window on project change.
+
 
 ## Visibility Control
 

activity_browser/bwutils/README.md

@@ -10,8 +10,8 @@ This module provides a collection of generic methods and utilities that wrap and
 
 - **`ecoinvent_biosphere_versions/`** - Ecoinvent biosphere database version mappings
 - **`io/`** - Import/export operations for data interchange
-- **`metadata/`** - Metadata management for activities and databases
-- **`searchengine/`** - Search functionality for activities and exchanges
+- **`metadata/`** - Metadata loading and caching for quick access
+- **`searchengine/`** - Fuzzy search functionality for dataframes
 - **`superstructure/`** - Superstructure scenario analysis tools
 
 ## Key Files
@@ -46,8 +46,6 @@ Import utilities as needed throughout the application:
 
 ```python
 from activity_browser.bwutils import commontasks
-from activity_browser.bwutils.errors import ABError
-from activity_browser.bwutils.manager import ABManager
 ```
 
 ## Design Principle
@@ -56,4 +54,3 @@ Keep utilities generic and reusable. These functions should:
 - Work with Brightway2 data structures
 - Be independent of UI components
 - Be testable without requiring a GUI
-- Emit signals when state changes (via `activity_browser.app.signals`)