liberata_metrics package

Subpackages

• liberata_metrics.generators package
  • Submodules
    • liberata_metrics.generators.generate_matrices module
      • Manuscript
      • build_COO()
      • build_capital_matrix()
      • generate_capital_time_series()
      • generate_references_matrix()
      • generate_shares_matrix()
      • get_capital_earlier()
      • get_references_earlier()
      • update_retractions_graph()
  • Module contents
    • build_capital_matrix()
    • generate_capital_time_series()
    • generate_references_matrix()
    • generate_shares_matrix()
    • get_capital_earlier()
    • update_retractions_graph()
• liberata_metrics.integrations package
  • Submodules
    • liberata_metrics.integrations.supabase module
  • Module contents
• liberata_metrics.metrics package
  • Submodules
    • liberata_metrics.metrics.distribution_metrics module
      • hhi_discrepancy()
      • share_splits_inequality()
    • liberata_metrics.metrics.graph module
    • liberata_metrics.metrics.legacy_metric module
      • get_author_citations()
      • get_citation_counts()
      • get_g_index()
      • get_h_index()
      • get_i10_index()
    • liberata_metrics.metrics.market_metrics module
      • compute_fair_marketprice()
      • compute_relative_performance()
      • compute_risk_adjusted_excess_return()
      • compute_risk_adjusted_relative_performance()
      • compute_risk_premiums()
      • compute_sensitivity()
      • compute_utility_function()
    • liberata_metrics.metrics.portfolio_metrics module
      • academic_capital()
      • allocation_weights()
      • get_arc()
      • get_col_indices()
      • get_diversification_ratio()
      • get_expected_proportional_returns()
      • get_expected_returns()
      • get_funding_efficiency()
      • get_manuscript_memberships_matrix()
      • get_per_manuscript_cap()
      • get_proportional_return()
      • get_proportional_split()
      • get_returns()
      • get_risk_asymmetry()
      • get_sharpe_ratio()
      • get_time_efficiency()
      • get_volatility()
      • mix_by_role()
      • mix_by_tag()
      • portfolio_gini()
      • portfolio_hhi()
      • portfolio_normalized_entropy()
      • query_portfolio_mix()
      • role_based_proportional_loss()
    • liberata_metrics.metrics.system_health_metrics module
      • get_academic_capital_growth_rate()
      • get_field_capital_shares()
      • get_funding_efficiency()
      • get_gdp_efficiency()
      • get_gini_per_capita()
      • get_gini_per_contributor()
      • get_gini_per_gdp()
      • get_ppp_efficiency()
      • get_regional_academic_capital()
      • get_regional_hhi()
      • get_replicator_fmp_volatility()
      • get_replicator_shrinkage_rate()
      • get_reviewer_fmp_volatility()
      • get_reviewer_shrinkage_rate()
      • get_time_efficiency()
      • total_fair_market_price()
  • Module contents
    • academic_capital()
    • allocation_weights()
    • compute_fair_marketprice()
    • compute_relative_performance()
    • compute_risk_adjusted_excess_return()
    • compute_risk_adjusted_relative_performance()
    • compute_risk_premiums()
    • compute_sensitivity()
    • compute_utility_function()
    • get_author_citations()
    • get_citation_counts()
    • get_g_index()
    • get_h_index()
    • get_i10_index()
    • get_manuscript_memberships_matrix()
    • get_per_manuscript_cap()
    • hhi_discrepancy()
    • mix_by_role()
    • mix_by_tag()
    • portfolio_gini()
    • portfolio_hhi()
    • portfolio_normalized_entropy()
    • query_portfolio_mix()
    • role_based_proportional_loss()
    • share_splits_inequality()
• liberata_metrics.utils package
  • Submodules
    • liberata_metrics.utils.data_loading module
      • read_yaml_config()
      • save_sparse_npz()
    • liberata_metrics.utils.data_wrangling module
      • coo_to_binned_array()
      • deserialize_upload_dates()
      • make_date_grid()
      • matrix_to_plot_array()
      • serialize_upload_dates()
    • liberata_metrics.utils.load_supabase_data module
    • liberata_metrics.utils.utils module
      • random_date()
      • sparse_divide()
  • Module contents
    • coo_to_binned_array()
    • deserialize_upload_dates()
    • make_date_grid()
    • matrix_to_plot_array()
    • random_date()
    • read_yaml_config()
    • save_sparse_npz()
    • serialize_upload_dates()
• liberata_metrics.visualizations package
  • Submodules
    • liberata_metrics.visualizations.matrix_visuals module
      • matrix_heatmap()
    • liberata_metrics.visualizations.time_series_visuals module
      • plot_contributor_time_series()
      • plot_manuscript_time_series()
  • Module contents
    • matrix_heatmap()
    • plot_contributor_time_series()
    • plot_manuscript_time_series()

Submodules

• liberata_metrics.logging module
  • configure_logging()
  • get_logger()

Module contents

liberata_metrics.configure_logging(level: str | None = None, log_file: str | None = None, max_bytes: int = 10000000, backup_count: int = 5, fmt: str | None = None) → None

Configure application-level logging for scripts/CLIs.

Call this once from top-level entrypoints (scripts, CLI) before performing work.

Parameters:

• level (Optional[str]) – Logging level name (e.g., “DEBUG”, “INFO”). If None, reads from environment variable LOG_LEVEL or defaults to “INFO”.

• log_file (Optional[str]) – Path to a rotating log file. If provided, a RotatingFileHandler is added. Parent directories are created if necessary.

• max_bytes (int) – Maximum bytes per log file before rotation.

• backup_count (int) – Number of rotated log files to keep.

• fmt (Optional[str]) – Optional log format string. If None, a sensible default is used.

Notes

• This function configures the root logger. Library modules should not call this; only application code (scripts or CLI entrypoints) should configure logging.

• Multiple calls are safe: if the root logger already has handlers, the function sets the level and returns early to avoid duplicate handlers in interactive runs.

Example

from liberata_metrics.logging import configure_logging configure_logging(level=”DEBUG”, log_file=”logs/run.log”)

liberata_metrics.get_logger(name: str | None = None) → Logger

Return a library logger.

Usage (inside library modules):

logger = get_logger(__name__) logger.debug(“message”)

This logger installs a NullHandler by default so importing the library does not configure application logging or emit output. Application code (scripts/CLI) should call configure_logging() once at startup to enable handlers/formatting.

Parameters:

name (Optional[str]) – Optional module name to append to the library logger root. If provided the returned logger name will be “liberata_metrics.<name>”.

Returns:

Configured logger object (may carry NullHandler by default).

Return type:

logging.Logger