brightway-basic-explorer 0.9.dev4__tar.gz → 0.9.dev6__tar.gz

{brightway_basic_explorer-0.9.dev4 → brightway_basic_explorer-0.9.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brightway-basic-explorer
-Version: 0.9.dev4
+Version: 0.9.dev6
 Summary: Implement basic GUI to explorer brightway ativities
 Author-email: Benoît GSCHWIND <benoit.gschwind@minesparis.psl.eu>, OIE - Mines Paris PSL <benoit.gschwind@minesparis.psl.eu>
 Maintainer-email: Benoît GSCHWIND <benoit.gschwind@minesparis.psl.eu>
@@ -29,13 +29,15 @@ Implement a basic activity explorer mostly to use in interractive python such as
 pip install brightway_basic_explorer
 ```
 
-# Sample and Documentation
+# Documentation
 
 ![Sample Window](https://github.com/gschwind/brightway-basic-explorer/raw/main/doc/sample-window.png)
 
+## Show an activity
+
 ```python
 import bw2data
-from brightway_basic_explorer import show_activity, close_all
+from brightway_basic_explorer import show_activity, close_all, search
 
 db = bw2data.Database("ecoinvent-3.11-cutoff")
 
@@ -43,7 +45,27 @@ act = db.search("570kWp")
 
 # Show the first activity
 show_activity(act[0])
+```
 
-# Close all activity windows
+## Close all activities windows
+
+```python
 close_all()
 ```
+
+## With lca_algebraic
+
+If you are ussing lca_algebraic, you can specify parameters. Parameters are completed by default values and used in formula to compute the corresponding amount.
+
+```python
+show_activity(act[0], {"paramter0": 10, "parameter1": 20})
+```
+
+## Search within a database:
+
+You can search within a database. Search require at less a not too short keyword. Keyword are separated by spaces, for instance:
+
+```python
+search("ecoinvent-3.11-cutoff", "570kwp GLO")
+```
+

brightway_basic_explorer-0.9.dev6/README.md

@@ -0,0 +1,50 @@
+# Brightway Basic Explorer
+
+Implement a basic activity explorer mostly to use in interractive python such as notebooks, ipython and spyder.
+
+# Install
+
+```
+pip install brightway_basic_explorer
+```
+
+# Documentation
+
+![Sample Window](https://github.com/gschwind/brightway-basic-explorer/raw/main/doc/sample-window.png)
+
+## Show an activity
+
+```python
+import bw2data
+from brightway_basic_explorer import show_activity, close_all, search
+
+db = bw2data.Database("ecoinvent-3.11-cutoff")
+
+act = db.search("570kWp")
+
+# Show the first activity
+show_activity(act[0])
+```
+
+## Close all activities windows
+
+```python
+close_all()
+```
+
+## With lca_algebraic
+
+If you are ussing lca_algebraic, you can specify parameters. Parameters are completed by default values and used in formula to compute the corresponding amount.
+
+```python
+show_activity(act[0], {"paramter0": 10, "parameter1": 20})
+```
+
+## Search within a database:
+
+You can search within a database. Search require at less a not too short keyword. Keyword are separated by spaces, for instance:
+
+```python
+search("ecoinvent-3.11-cutoff", "570kwp GLO")
+```
+

{brightway_basic_explorer-0.9.dev4 → brightway_basic_explorer-0.9.dev6}/brightway_basic_explorer/__init__.py

@@ -3,6 +3,7 @@
 from IPython.external.qt_for_kernel import QtGui, QtCore
 from IPython.lib.guisupport import get_app_qt4, is_event_loop_running_qt4
 
+import re
 import os
 import sys
 import bw2data
@@ -51,6 +52,20 @@ def activity_to_json_with_params(act, params):
     a["exchanges"] = exs
     return a
 
+def warn_dialog(msg):
+    print(f"WARNING: {msg}")
+    w = QtGui.QMessageBox(QtGui.QMessageBox.Icon.Warning, "WARNING", msg)
+    w.show()
+    w.setMaximumSize(800, 600)
+    w.exec()
+
+def fatal_dialog(msg):
+    print(f"ERROR: {msg}")
+    w = QtGui.QMessageBox(QtGui.QMessageBox.Icon.Critical, "ERROR", msg)
+    w.show()
+    w.setMaximumSize(800, 600)
+    w.exec()
+
 class QStandardItemRO(QtGui.QStandardItem):
     def __init__(self, *args, data=None, **kwargs):
         super().__init__(*args, **kwargs)
@@ -58,8 +73,7 @@ class QStandardItemRO(QtGui.QStandardItem):
         self.setSelectable(True)
         self.setData(data)
 
-
-class TableModel(QtGui.QStandardItemModel):
+class ExchangeModel(QtGui.QStandardItemModel):
     def __init__(self, parent=None):
         super().__init__(parent)
         self.setColumnCount(6)
@@ -103,14 +117,19 @@ class ActionMenu(QtGui.QMenu):
         self.action_copy = self.addAction("Copy")
         self.action_copy.triggered.connect(self.copy_triggered)
 
-        self.action_copy = self.addAction("Copy Full Reference")
-        self.action_copy.triggered.connect(self.copy_full_reference_triggered)
+        self.action_copy_ref = self.addAction("Copy Full Reference")
+        self.action_copy_ref.triggered.connect(self.copy_full_reference_triggered)
 
-        self.action_explore = self.addAction("Explore")
-        self.action_explore.triggered.connect(self.explore_triggered)
+        self.action_copy_code = self.addAction("Copy Activity Code")
+        self.action_copy_code.triggered.connect(self.copy_code_triggered)
 
-        self.action_explore = self.addAction("Explore in new window")
-        self.action_explore.triggered.connect(self.explore_in_new_window_triggered)
+        if hasattr(self.parentWidget(), "explore"):
+            self.action_explore = self.addAction("Explore")
+            self.action_explore.triggered.connect(self.explore_triggered)
+
+        if hasattr(self.parentWidget(), "explore_in_new_window"):
+            self.action_explore = self.addAction("Explore in new window")
+            self.action_explore.triggered.connect(self.explore_in_new_window_triggered)
 
     def copy_triggered(self):
         QtGui.QGuiApplication.clipboard().setText(self.index.data())
@@ -121,6 +140,12 @@ class ActionMenu(QtGui.QMenu):
         text = (v["database"], v["name"], v.get("location", None), v.get("categories", tuple()), v.get("unit", None))
         QtGui.QGuiApplication.clipboard().setText(str(text))
 
+    def copy_code_triggered(self):
+        parent = self.parentWidget()
+        v = parent.model.root.child(self.index.row(), 0).data()
+        text = (v["database"], v["code"])
+        QtGui.QGuiApplication.clipboard().setText(str(text))
+
     def explore_triggered(self):
         self.parentWidget().explore(self.index)
 
@@ -223,7 +248,7 @@ class ActivityTab(QtGui.QWidget):
         self.tree_view.setSortingEnabled(True)
         self.tree_view.setAlternatingRowColors(True)
 
-        self.model = TableModel()
+        self.model = ExchangeModel()
         self.model.load(activity_json["exchanges"])
         self.tree_view.setModel(self.model)
         self.tree_view.doubleClicked.connect(self.doubleCliked)
@@ -271,6 +296,154 @@ class ActivityTab(QtGui.QWidget):
         act = bw2data.get_activity((v["database"], v["code"]))
         show_activity(act, self.xparent.params)
 
+class SearchModel(QtGui.QStandardItemModel):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.setColumnCount(4)
+        self.setHeaderData(0, QtCore.Qt.Orientation.Horizontal, "Name")
+        self.setHeaderData(1, QtCore.Qt.Orientation.Horizontal, "Unit")
+        self.setHeaderData(2, QtCore.Qt.Orientation.Horizontal, "Category")
+        self.setHeaderData(3, QtCore.Qt.Orientation.Horizontal, "Location")
+
+    def load(self, data):
+        self.exchanges = [e for e in data]
+        self.root = self.invisibleRootItem()
+        for e in data:
+            row = [
+                QStandardItemRO(str(e.get(k, "-")), data=e)
+                for k in ["name", "unit", "categories", "location"]
+            ]
+
+            etype = e.get("type", "unknown")
+            if etype == "emission":
+                path = os.path.join(os.path.dirname(__file__), "icons", "emission.png")
+            elif etype in {"process", "processwithreferenceproduct"}:
+                path = os.path.join(os.path.dirname(__file__), "icons", "process.png")
+            elif etype == "natural resource":
+                path = os.path.join(os.path.dirname(__file__), "icons", "natural_resource.png")
+            else:
+                path = os.path.join(os.path.dirname(__file__), "icons", "unknown.png")
+
+            row[0].setIcon(QtGui.QIcon(path))
+            self.root.appendRow(row)
+
+class SearchWindow(QtGui.QMainWindow):
+    def __init__(self, db, keywords=""):
+        super().__init__()
+
+        self.db = db
+
+        self.setWindowTitle("Search Activity")
+        self.setMinimumSize(QtCore.QSize(800, 600))
+
+        central_widget = QtGui.QWidget()
+        self.setCentralWidget(central_widget)
+        layout = QtGui.QVBoxLayout()
+        central_widget.setLayout(layout)
+
+        grid = QtGui.QGridLayout()
+        layout.addLayout(grid)
+
+        next_row = grid.rowCount()
+        grid.addWidget(QtGui.QLabel("database:"), next_row, 0)
+        grid.addWidget(QtGui.QLabel(self.db.name), next_row, 1)
+
+        # Keyword query
+        next_row = grid.rowCount()
+        grid.addWidget(QtGui.QLabel("keywords:"), next_row, 0)
+        self.keywords = QtGui.QLineEdit("")
+        self.keywords.setText(keywords)
+        self.keywords.returnPressed.connect(self.update_search)
+        grid.addWidget(self.keywords, next_row, 1)
+        self.keywords_button = QtGui.QPushButton("Update")
+        self.keywords_button.clicked.connect(self.update_search)
+
+        grid.addWidget(self.keywords_button, next_row, 2)
+
+        next_row = grid.rowCount()
+        grid.addWidget(QtGui.QLabel("filter:"), next_row, 0)
+        self.filter_edit = QtGui.QLineEdit("")
+        self.filter_edit.textChanged.connect(self.update_filter)
+        grid.addWidget(self.filter_edit, next_row, 1)
+        grid.setColumnStretch(0, 0)
+        grid.setColumnStretch(1, 1)
+        self.ignore_case = QtGui.QCheckBox("Ignore Case")
+        self.ignore_case.setChecked(True)
+        if hasattr(self.ignore_case, "checkStateChanged"):
+            self.ignore_case.checkStateChanged.connect(self.update_filter)
+        else:
+            self.ignore_case.stateChanged.connect(self.update_filter)
+        next_row = grid.rowCount()
+        grid.addWidget(self.ignore_case, next_row, 1)
+
+        # Create tree view
+        self.tree_view = QtGui.QTreeView()
+        layout.addWidget(self.tree_view)
+        self.tree_view.setSortingEnabled(True)
+        self.tree_view.setAlternatingRowColors(True)
+        self.tree_view.doubleClicked.connect(self.doubleCliked)
+        self.tree_view.setExpandsOnDoubleClick(False)
+        self.tree_view.setSelectionBehavior(QtGui.QAbstractItemView.SelectionBehavior.SelectItems)
+        self.tree_view.setContextMenuPolicy(QtCore.Qt.ContextMenuPolicy.CustomContextMenu)
+        self.tree_view.customContextMenuRequested.connect(self.context_menu)
+
+        self.model = None
+
+        self.update_search()
+
+    def update_search(self):
+        text = self.keywords.text()
+        keywords = [re.sub("[^a-zA-Z0-9_-]", "", s) for s in text.split(" ") if len(s) > 0]
+        if all(len(x) < 3 for x in keywords):
+            warn_dialog("Too smalls keywords")
+            return
+
+        acts = self.db.search(" ".join(keywords), proxy=True, limit=200)
+        acts = [dict(a) for a in acts]
+
+        old_model = self.model
+        self.model = SearchModel()
+        self.model.load(acts)
+        self.tree_view.setModel(self.model)
+        if old_model is not None:
+            old_model.deleteLater()
+        self.tree_view.setColumnWidth(0, 400)
+
+    def context_menu(self, point):
+        index = self.tree_view.indexAt(point)
+        self.action_menu = ActionMenu(self, index)
+        self.action_menu.exec(self.tree_view.viewport().mapToGlobal(point))
+
+    def update_filter(self, *args):
+        if self.model is None:
+            return
+
+        text = self.filter_edit.text()
+        if self.ignore_case.isChecked():
+            text = text.lower()
+            index = self.model.root.index()
+            for i in range(self.model.rowCount()):
+                v = self.model.root.child(i, 0).data()
+                self.tree_view.setRowHidden(i, index, text not in v["name"].lower())
+        else:
+            index = self.model.root.index()
+            for i in range(self.model.rowCount()):
+                v = self.model.root.child(i, 0).data()
+                self.tree_view.setRowHidden(i, index, text not in v["name"])
+
+    def doubleCliked(self, index):
+        self.explore_in_new_window(index)
+
+    def explore_in_new_window(self, index):
+        r = index.row()
+        v = self.model.root.child(r, 0).data()
+        act = bw2data.get_activity((v["database"], v["code"]))
+        show_activity(act)
+
+    def show(self, *args, **kwargs):
+        self.tree_view.setColumnWidth(0, 400)
+        super().show(*args, **kwargs)
+
 
 # Replace IPython version to one compatible with Qt6
 def start_event_loop_qt4(app=None):
@@ -297,6 +470,9 @@ def show_activity(act, params=None):
 
     app = get_app_qt4()
 
+    if isinstance(act, tuple):
+        act = bw2data.get_activity(act)
+
     if params is None:
         activity_json = activity_to_json(act)
     else:
@@ -311,6 +487,31 @@ def show_activity(act, params=None):
 
     window.activateWindow()
 
+def search(database, keywords=""):
+
+    if 'matplotlib' in sys.modules:
+        import matplotlib
+        if hasattr(matplotlib.backends, "backend"):
+            if 'qt' not in matplotlib.backends.backend:
+                print("WARNING: ActivityGUI will block, use `%matplotlib qt` to avoid blocking")
+
+    app = get_app_qt4()
+
+    if isinstance(database, str):
+        if database not in bw2data.databases:
+            fatal_dialog(f"Database {database} not found !")
+            return
+        database = bw2data.Database(database)
+
+    window = SearchWindow(database, keywords)
+    window.show()
+
+    if not is_event_loop_running_qt4(app):
+        start_event_loop_qt4(app)
+
+    window.activateWindow()
+    return window
+
 def close_all():
     for w in list(ActivityWindow.keep):
         w.close()

{brightway_basic_explorer-0.9.dev4 → brightway_basic_explorer-0.9.dev6}/brightway_basic_explorer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brightway-basic-explorer
-Version: 0.9.dev4
+Version: 0.9.dev6
 Summary: Implement basic GUI to explorer brightway ativities
 Author-email: Benoît GSCHWIND <benoit.gschwind@minesparis.psl.eu>, OIE - Mines Paris PSL <benoit.gschwind@minesparis.psl.eu>
 Maintainer-email: Benoît GSCHWIND <benoit.gschwind@minesparis.psl.eu>
@@ -29,13 +29,15 @@ Implement a basic activity explorer mostly to use in interractive python such as
 pip install brightway_basic_explorer
 ```
 
-# Sample and Documentation
+# Documentation
 
 ![Sample Window](https://github.com/gschwind/brightway-basic-explorer/raw/main/doc/sample-window.png)
 
+## Show an activity
+
 ```python
 import bw2data
-from brightway_basic_explorer import show_activity, close_all
+from brightway_basic_explorer import show_activity, close_all, search
 
 db = bw2data.Database("ecoinvent-3.11-cutoff")
 
@@ -43,7 +45,27 @@ act = db.search("570kWp")
 
 # Show the first activity
 show_activity(act[0])
+```
 
-# Close all activity windows
+## Close all activities windows
+
+```python
 close_all()
 ```
+
+## With lca_algebraic
+
+If you are ussing lca_algebraic, you can specify parameters. Parameters are completed by default values and used in formula to compute the corresponding amount.
+
+```python
+show_activity(act[0], {"paramter0": 10, "parameter1": 20})
+```
+
+## Search within a database:
+
+You can search within a database. Search require at less a not too short keyword. Keyword are separated by spaces, for instance:
+
+```python
+search("ecoinvent-3.11-cutoff", "570kwp GLO")
+```
+

{brightway_basic_explorer-0.9.dev4 → brightway_basic_explorer-0.9.dev6}/pyproject.toml

@@ -12,7 +12,7 @@ name = "brightway-basic-explorer"
 description = "Implement basic GUI to explorer brightway ativities"
 readme = "README.md"
 license-files = ["COPYING"]
-version = "0.9.dev4"
+version = "0.9.dev6"
 dependencies = [ "ipython" ]
 requires-python = ">= 3.10"
 keywords = ["lca", "ecoinvent", "brightway"]

brightway_basic_explorer-0.9.dev4/README.md

@@ -1,28 +0,0 @@
-# Brightway Basic Explorer
-
-Implement a basic activity explorer mostly to use in interractive python such as notebooks, ipython and spyder.
-
-# Install
-
-```
-pip install brightway_basic_explorer
-```
-
-# Sample and Documentation
-
-![Sample Window](https://github.com/gschwind/brightway-basic-explorer/raw/main/doc/sample-window.png)
-
-```python
-import bw2data
-from brightway_basic_explorer import show_activity, close_all
-
-db = bw2data.Database("ecoinvent-3.11-cutoff")
-
-act = db.search("570kWp")
-
-# Show the first activity
-show_activity(act[0])
-
-# Close all activity windows
-close_all()
-```