v0.8.0

.github/actions/check_namespace_file_consistency.py

@@ -0,0 +1,67 @@
+"""
+Dev-only namespace consistency checker.
+
+- Reads a fixed Markdown file to get the list of standard variable names.
+- Imports `svn` from `firebench` to get the authoritative list from code.
+- Compares both lists and prints differences.
+- No argparse, no unit/type checks, no JSON.
+
+Usage:
+    in root directory: make check-consistency-namespace
+"""
+
+import re
+from pathlib import Path
+
+# Docs path
+NAMESPACE_DOCS = Path("docs/namespace.md")
+_MD_NAME_RE = re.compile(r"-\s*`([^`]+)`")
+
+
+def get_md_variables(md_path: Path) -> list[str]:
+    """Return the list of variable names listed in the Markdown spec."""
+    text = md_path.read_text(encoding="utf-8")
+    return _MD_NAME_RE.findall(text)
+
+
+def get_svn_variables() -> list[str]:
+    """Return the list of variable names from `firebench.svn`.
+
+    Supports several shapes:
+      - Enum class (uses __members__)
+      - dict of names
+      - list/tuple/set of names
+      - module / object with UPPERCASE attributes
+    """
+    from firebench import svn
+
+    # Enum class (most common)
+    members = getattr(svn, "__members__", None)
+    if isinstance(members, dict):
+        return sorted(members.keys())
+
+    # collect UPPERCASE attribute names on the object/module
+    names = [n for n in dir(svn) if n.isupper() and not n.startswith("_")]
+    return sorted(set(names))
+
+
+def check_consistency() -> None:
+    md_vars = set(get_md_variables(NAMESPACE_DOCS))
+    svn_vars = set(get_svn_variables())
+
+    only_in_docs = sorted(md_vars - svn_vars)
+    only_in_svn = sorted(svn_vars - md_vars)
+    common = sorted(md_vars & svn_vars)
+
+    print("== Namespace Consistency Check ==")
+    print(f"Common: {len(common)}")
+    print(f"Only in docs (missing from svn): {len(only_in_docs)}")
+    for name in only_in_docs:
+        print(f"  - {name}")
+    print(f"Only in svn (missing from docs): {len(only_in_svn)}")
+    for name in only_in_svn:
+        print(f"  - {name}")
+
+
+if __name__ == "__main__":
+    check_consistency()

.github/actions/update_changelog_in_docs.py

@@ -17,7 +17,7 @@ def update_changelog_in_docs():
         changelog_content = root_file.read()
 
     # Front matter for the docs/changelog.md file
-    front_matter = """# 11. """
+    front_matter = """# 12. """
 
     # Combine front matter and changelog content
     full_changelog_content = front_matter + changelog_content[2:]

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [0.8.0] - 2026 / 01 / 14
+### Added
+- 2021 Caldor case FB001 documentation and benchmarks (See Zenodo FireBench for release)
+- package `metrics`: contains kpi functions, metrics functions for perimeters, 1D datasets, confusion matrix.
+- package `standardize`: contains standardization functions for landfire, mtbs, ravg, synoptic, geotiff.
+- package `signing`: contains functions for certification (hardware encryption) and verification of certificates (`verify_certificate_in_dict`, `verify_certificates_in_h5`). Verification functions require `gpg` (not needed for benchmarking functions).
+- Public Key for certificates verification
+
+### Documentation
+- FireBench Standard file format
+- Add Key Performance Indicators, Metrics, Score and Normalization information
+
 ## [0.7.0] - 2025 / 08 / 09
 ### Added
 - `anderson_2015_stats`: Plot statistics from the Anderson 2015 dataset.

Makefile

@@ -1,5 +1,5 @@
 # Declare these targets as phony to avoid conflicts with files of the same name
-.PHONY: test test-cov lint update-lint-score code-formatting bandit update-docs-changelog generate-api-doc docs clean
+.PHONY: test test-cov lint update-lint-score code-formatting bandit update-docs-changelog check-consistency-namespace generate-api-doc docs clean
 
 # Run all tests without coverage report
 test:
@@ -32,6 +32,10 @@ bandit:
 update-docs-changelog:
 	python .github/actions/update_changelog_in_docs.py
 
+# Check consistency between namespace in package and in docs
+check-consistency-namespace:
+	python .github/actions/check_namespace_file_consistency.py
+
 # Update API documentation
 generate-api-doc:
 	python .github/actions/generate_api_docs.py

README.md

@@ -10,7 +10,7 @@
 [![pages-build-deployment](https://github.com/wirc-sjsu/firebench/actions/workflows/pages/pages-build-deployment/badge.svg?branch=main)](https://github.com/wirc-sjsu/firebench/actions/workflows/pages/pages-build-deployment)
 [![codecov](https://codecov.io/github/wirc-sjsu/firebench/graph/badge.svg?token=8F44OX12EW)](https://codecov.io/github/wirc-sjsu/firebench)
 [![Security Analysis](https://github.com/wirc-sjsu/firebench/actions/workflows/security.yml/badge.svg?branch=main)](https://github.com/wirc-sjsu/firebench/actions/workflows/security.yml)
-![Pylint Score](https://img.shields.io/badge/Pylint-10.00-brightgreen.svg)
+![Pylint Score](https://img.shields.io/badge/Pylint-9.44-brightgreen.svg)
 [![Check linting with Pylint](https://github.com/wirc-sjsu/firebench/actions/workflows/pylint.yml/badge.svg?branch=main)](https://github.com/wirc-sjsu/firebench/actions/workflows/pylint.yml)
 [![Black Code Formatting Check](https://github.com/wirc-sjsu/firebench/actions/workflows/black.yml/badge.svg?branch=main)](https://github.com/wirc-sjsu/firebench/actions/workflows/black.yml)
 ![GitHub License](https://img.shields.io/github/license/wirc-sjsu/firebench)

docs/api/metrics.rst

@@ -9,3 +9,17 @@ Perimeters
    :undoc-members:
    :show-inheritance:
 
+Confusion Matrix
+----------------
+
+.. automodule:: firebench.metrics.confusion_matrix.binary_performance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: firebench.metrics.confusion_matrix.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+