Bumping to v0.5.5

* bumping version

* removed numpyencoder dependency (#75)

* Fixed groupby(axis=1) FutureWarning (except for pymrio dep)

* Removed indicators.py for the time being (not used currently)

* updated poetry.lock

* Presumably fixes #73

* CI/CD update

   - update black action to run only on master during pull request
   - Improved caching of venv

* Badges !

* updated documentation

* Created dependabot.yml

Author: spjuhel

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/pyproject.toml" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"

.github/workflows/CI.yml

@@ -0,0 +1,25 @@
+name: CI
+on: pull_request
+
+jobs:
+  ci:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install the project dependencies
+        run: poetry install
+      - name: Run black
+        run: poetry run black --check --verbose ./boario
+      - name: Run the automated tests (for example)
+        run: poetry run pytest -v

.github/workflows/black.yml

@@ -5,6 +5,32 @@
 BoARIO
 #######
 
+
+.. image:: https://img.shields.io/github/actions/workflow/status/spjuhel/boario/CI.yml
+   :target: https://github.com/spjuhel/BoARIO/actions/workflows/CI.yml
+   :alt: GitHub Actions Workflow Status
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000
+   :target: https://github.com/psf/black
+   :alt: Code Style - Black
+
+.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
+   :target: https://github.com/spjuhel/BoARIO/issues
+   :alt: Contribution - Welcome
+
+.. image:: https://img.shields.io/badge/License-GPLv3-blue
+   :target: https://www.gnu.org/licenses/gpl-3.0
+   :alt: Licence - GPLv3
+
+.. image:: https://img.shields.io/pypi/v/boario
+   :target: https://pypi.org/project/boario/
+   :alt: PyPI - Version
+
+.. image:: https://img.shields.io/pypi/pyversions/boario
+   :target: https://pypi.org/project/boario/
+   :alt: PyPI - Python Version
+
+
 `BoARIO` : The Adaptative Regional Input Output model in python.
 
 .. _`Documentation Website`: https://spjuhel.github.io/BoARIO/boario-what-is.html

.github/workflows/main.yml .github/workflows/gitlabsync.yml.github/workflows/main.yml renamed to .github/workflows/gitlabsync.yml

@@ -14,13 +14,12 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 try:
-    import coloredlogs as coloredlogs
+    import coloredlogs as coloredlogs  # noqa: F401
 except ImportError:
     _has_coloredlogs = False
 else:
     _has_coloredlogs = True
 
-import pathlib
 import importlib.metadata
 import logging
 from functools import lru_cache
@@ -53,7 +52,7 @@
         logger.info("You are using boario from branch %s", __git_branch__)
     except pygit2.GitError:
         logger.info(
-            f"Could not find git branch, this is normal if you installed boario from pip."
+            "Could not find git branch, this is normal if you installed boario from pip."
         )
 except ModuleNotFoundError:
     logger.info("Unable to tell git branch as pygit2 was not found.")

README.rst

@@ -14,22 +14,24 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
+
+import inspect
+import math
+import warnings
 from abc import ABC, abstractmethod
-from typing import Callable, Optional, Union, List, Tuple, get_origin, get_args
-import numpy.typing as npt
+from functools import partial
+from typing import Callable, List, Optional, Tuple, Union
+
 import numpy as np
+import numpy.typing as npt
 import pandas as pd
-import math
-import inspect
-from functools import partial
-import warnings
 
 from boario import logger
 from boario.utils.recovery_functions import (
     concave_recovery,
     convexe_recovery,
-    linear_recovery,
     convexe_recovery_scaled,
+    linear_recovery,
 )
 
 __all__ = [
@@ -334,10 +336,10 @@ def from_scalar_industries(
             Event: An Event object or one of its subclass.
         """
         if impact <= 0:
-            raise ValueError(f"Impact is null")
+            raise ValueError("Impact is null")
 
         if len(industries) < 1:
-            raise ValueError(f"Null sized affected industries ?")
+            raise ValueError("Null sized affected industries ?")
 
         if isinstance(industries, list):
             industries = pd.MultiIndex.from_tuples(
@@ -403,7 +405,7 @@ def from_scalar_regions_sectors(
             Event: An Event object or one of its subclass
         """
         if impact <= 0:
-            raise ValueError(f"Impact is null")
+            raise ValueError("Impact is null")
 
         if isinstance(regions, str):
             regions = [regions]
@@ -415,10 +417,10 @@ def from_scalar_regions_sectors(
         _sectors = pd.Index(sectors, name="sector")
 
         if len(_regions) < 1:
-            raise ValueError(f"Null sized affected regions ?")
+            raise ValueError("Null sized affected regions ?")
 
         if len(_sectors) < 1:
-            raise ValueError(f"Null sized affected sectors ?")
+            raise ValueError("Null sized affected sectors ?")
 
         if _sectors.duplicated().any():
             warnings.warn(
@@ -687,7 +689,8 @@ def impact_industries_distrib(self) -> pd.Series:
     def impact_industries_distrib(self, value: pd.Series):
         self._impact_industries_distrib = value
         self._impact_regional_distrib = self._impact_industries_distrib.groupby(
-            "region"
+            "region",
+            observed=False,
         ).sum()
 
     def __repr__(self):

boario/__init__.py

@@ -15,14 +15,17 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 from __future__ import annotations
+
 from typing import Dict, Optional
+
 import numpy as np
 import pandas as pd
-from boario import logger
-from boario.model_base import *
-from boario.event import *
 from pymrio.core.mriosystem import IOSystem
 
+from boario import logger
+
+from boario.model_base import ARIOBaseModel, INV_THRESHOLD
+
 __all__ = ["ARIOPsiModel"]
 
 
@@ -90,9 +93,11 @@ def __init__(
 
         if isinstance(inventory_restoration_tau, int):
             restoration_tau = [
-                (self.n_temporal_units_by_step / inventory_restoration_tau)
-                if v >= INV_THRESHOLD
-                else v
+                (
+                    (self.n_temporal_units_by_step / inventory_restoration_tau)
+                    if v >= INV_THRESHOLD
+                    else v
+                )
                 for v in self.inventories
             ]  # for sector with no inventory TODO: reflect on that.
         elif isinstance(inventory_restoration_tau, dict):