mergeron 2024.738953.1__tar.gz → 2024.738973.0__tar.gz

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.738953.1
+Version: 2024.738973.0
 Summary: Analysis of standards defined in Horizontal Merger Guidelines
 License: MIT
 Keywords: merger policy analysis,merger guidelines,merger screening,policy presumptions,concentration standards,upward pricing pressure,GUPPI
@@ -51,43 +51,58 @@ Intrinsic clearance and enforcement rates are distinguished from *observed* clea
 Modules of primary interest
 ---------------------------
 
-Routines for downloading and organizing FTC merger investigtions data published in 2004, 2007, 2008, and 2013. Includes a routine for constructing investigations data for non-overlapping periods, and other partitions on the data, subject to the constraints of the reported data.
 
-    mergeron.core.ftc_merger_investigations_data
 
-Routines for plotting boundaries of (sets of mergers falling within) specified concentration and diversion ratio boundaries and for calibrating GUPPI thresholds to concentration (ΔHHI) thresholds, and vice-versa.
+Methods for plotting boundaries of (sets of mergers falling within) specified concentration and share-ratio boundaries, are in :code:`mergeron.core.guidelines_boundaries`, where share-ratio, :math:`\delta_{ij}` is defined as :math:`\delta_{ij} = d_{ij} / r_i` with :math:`d_{ij}, r_i` a diversion ratio and recapture rate. This module also includes functions for calibrating GUPPI thresholds to concentration (ΔHHI) thresholds, and vice-versa.
 
-    mergeron.core.guidelines_boundaries
+Methods for generating industry data under various distributions of shares, prices, and margins are included in, :code:`mergeron.gen.data_generation`. The user can specify whether rates are specified as, "proportional", "inside-out" (i.e., consistent with merging-firms' in-market shares and a default recapture rate), or "outside-in", (i.e., purchase probabilities are drawn at random for :math:`n+1` goods, from which are derived market shares and recapture rates for the :math:`n` goods in the putative market). Price-cost-margins may be specified as symmetric, i.i.d, or consistent with equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand. Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified. Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented.
 
-Routines for generating industry data under various distributions of shares, prices, and margins. The user can specify whether rates are specified as, "proportional", "inside-out" (i.e., consistent with merging-firms' in-market shares and a default recapture rate), or "outside-in", (i.e., purchase probabilities are drawn at random for :math:`n+1` goods, from which are derived market shares and recapture rates for the :math:`n` goods in the putative market). Price-cost-margins may be specified as symmetric, i.i.d, or consistent with equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand. Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified. Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented.
+Methods for testing generated industry data against criteria on diversion ratio, gross upward pricing pressure ("GUPPI"), critical marginal cost reduction ("CMCR"), and indicative price rise ("IPR")/partial merger simulation are included in the module, :code:`mergeron.gen.guidelines_tests`. Test data are constructed in parallel and the user can specify number of `threads` and sub-sample size for each thread to manage CPU and memory utilization.
 
-    mergeron.gen.data_generation
+FTC investigations data and test data are printed to screen or rendered in LaTex to text files (for processing into publication-quality tables) using methods provided in :code:`mergeron.gen.investigations_stats`.
 
-Routines for testing generated industry data against criteria on diversion ratio, gross upward pricing pressure ("GUPPI"), critical marginal cost reduction ("CMCR"), and indicative price rise ("IPR")/partial merger simulation. Test data are constructed in parallel and the user can specify number of `threads` and sub-sample size for each thread to manage CPU and memory utilization.
+Programs demonstrating the analysis and reporting facilites provided by the sub-package, :code:`mergeron.examples`.
 
-    mergeron.gen.guidelines_tests
+This package exposes methods employed for generating random numbers with selected continuous distribution over specified parameters, and with CPU multithreading on machines with multiple virtual, logical, or physical CPU cores. To access these directly:
 
-FTC investigations data and test data are printed to screen or rendered in LaTex to text files (for processing into publication-quality tables) using routines provided in :code:`mergeron.gen.investigations_stats`.
-
-Programs demonstrating the analysis and reporting facilites provided by the package.
-
-    mergeron.examples
-
-This package exposes routines employed for generating random numbers with selected continuous distribution over specified parameters, and with CPU multithreading on machines with multiple virtual, logical, or physical CPU cores. To access these directly:
+.. code-block:: python
 
     import mergeron.core.pseudorandom_numbers as prng
 
-Also included are routines for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (Although coded from scratch using the source literature, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/).) To access these directly:
+Also included are methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (Although coded from scratch using the source literature, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/).) To access these directly:
+
+.. code-block:: python
 
     import mergeron.core.proportions_tests as prci
 
 A recent version of Paul Tol's python module, :code:`tol_colors.py` is redistributed within this package. Other than re-formatting and type annotation, the :code:`tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The tol_colors.py module is distributed under the Standard 3-clause BSD license. To access the tol_colors module directly:
 
+.. code-block:: python
+
     import mergeron.ext.tol_colors
 
 Documentation for this package is in the form of the API Reference. Documentation for individual functions and classes is accessible within a python shell. For example:
 
+.. code-block:: python
+
     import mergeron.core.data_generation as dgl
 
     help(dgl.gen_market_sample)
 
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT
+

mergeron-2024.738973.0/README.rst

@@ -0,0 +1,64 @@
+mergeron: Merger Policy Analysis with Python
+============================================
+
+Download and analyze merger investigations data published by the U.S. Federal Trade Commission in various reports on extended merger investigations during 1996 to 2011. Model the sets of mergers conforming to various U.S. Horizontal Merger Guidelines standards. Analyze intrinsic clearance rates and intrinsic enforcement rates under Guidelines standards using generated data with specified distributions of market shares, price-cost margins, firm counts, and prices, optionally imposing restrictions impled by statutory filing thresholds and/or Bertrand-Nash oligopoly with MNL demand.
+
+Intrinsic clearance and enforcement rates are distinguished from *observed* clearance and enforcement rates in that the former do not reflect the effects of screening and deterrence as do the latter.
+
+Modules of primary interest
+---------------------------
+
+
+
+Methods for plotting boundaries of (sets of mergers falling within) specified concentration and share-ratio boundaries, are in :code:`mergeron.core.guidelines_boundaries`, where share-ratio, :math:`\delta_{ij}` is defined as :math:`\delta_{ij} = d_{ij} / r_i` with :math:`d_{ij}, r_i` a diversion ratio and recapture rate. This module also includes functions for calibrating GUPPI thresholds to concentration (ΔHHI) thresholds, and vice-versa.
+
+Methods for generating industry data under various distributions of shares, prices, and margins are included in, :code:`mergeron.gen.data_generation`. The user can specify whether rates are specified as, "proportional", "inside-out" (i.e., consistent with merging-firms' in-market shares and a default recapture rate), or "outside-in", (i.e., purchase probabilities are drawn at random for :math:`n+1` goods, from which are derived market shares and recapture rates for the :math:`n` goods in the putative market). Price-cost-margins may be specified as symmetric, i.i.d, or consistent with equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand. Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified. Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented.
+
+Methods for testing generated industry data against criteria on diversion ratio, gross upward pricing pressure ("GUPPI"), critical marginal cost reduction ("CMCR"), and indicative price rise ("IPR")/partial merger simulation are included in the module, :code:`mergeron.gen.guidelines_tests`. Test data are constructed in parallel and the user can specify number of `threads` and sub-sample size for each thread to manage CPU and memory utilization.
+
+FTC investigations data and test data are printed to screen or rendered in LaTex to text files (for processing into publication-quality tables) using methods provided in :code:`mergeron.gen.investigations_stats`.
+
+Programs demonstrating the analysis and reporting facilites provided by the sub-package, :code:`mergeron.examples`.
+
+This package exposes methods employed for generating random numbers with selected continuous distribution over specified parameters, and with CPU multithreading on machines with multiple virtual, logical, or physical CPU cores. To access these directly:
+
+.. code-block:: python
+
+    import mergeron.core.pseudorandom_numbers as prng
+
+Also included are methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (Although coded from scratch using the source literature, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/).) To access these directly:
+
+.. code-block:: python
+
+    import mergeron.core.proportions_tests as prci
+
+A recent version of Paul Tol's python module, :code:`tol_colors.py` is redistributed within this package. Other than re-formatting and type annotation, the :code:`tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The tol_colors.py module is distributed under the Standard 3-clause BSD license. To access the tol_colors module directly:
+
+.. code-block:: python
+
+    import mergeron.ext.tol_colors
+
+Documentation for this package is in the form of the API Reference. Documentation for individual functions and classes is accessible within a python shell. For example:
+
+.. code-block:: python
+
+    import mergeron.core.data_generation as dgl
+
+    help(dgl.gen_market_sample)
+
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "mergeron"
 # See ./get_version_str.py
-version = "2024.738953.1"
+version = "2024.738973.0"
 description = "Analysis of standards defined in Horizontal Merger Guidelines"
 keywords = [
     "merger policy analysis",

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/src/mergeron/License.txt

@@ -1,7 +1,7 @@
 mergeron
 ========
 
-Copyright 2017-2023 S. Murthy Kambhampaty
+Copyright 2017-2024 S. Murthy Kambhampaty
 
 MIT License
 -----------

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/src/mergeron/core/__init__.py

@@ -1,15 +1,24 @@
 from __future__ import annotations
 
+from dataclasses import dataclass
 from importlib.metadata import version
 
-from attrs import Attribute, define, field, validators
+import numpy as np
+from attrs import Attribute, field, frozen, validators
+from numpy.typing import NDArray
 
 from .. import _PKG_NAME, RECConstants, UPPAggrSelector  # noqa: TID252
 
 __version__ = version(_PKG_NAME)
 
 
-def _delta_value_validator(
+@dataclass(frozen=True)
+class GuidelinesBoundary:
+    coordinates: NDArray[np.float64]
+    area: float
+
+
+def _divr_value_validator(
     _instance: UPPBoundarySpec, _attribute: Attribute[float], _value: float, /
 ) -> None:
     if not 0 <= _value <= 1:
@@ -38,15 +47,15 @@ def _rec_spec_validator(
         )
 
 
-@define(slots=True, frozen=True)
+@frozen
 class UPPBoundarySpec:
-    share_ratio: float = field(
+    diversion_ratio: float = field(
         kw_only=False,
-        default=0.075,
-        validator=(validators.instance_of(float), _delta_value_validator),
+        default=0.045,
+        validator=(validators.instance_of(float), _divr_value_validator),
     )
     rec: float = field(
-        kw_only=False, default=0.80, validator=validators.instance_of(float)
+        kw_only=False, default=0.855, validator=validators.instance_of(float)
     )
 
     agg_method: UPPAggrSelector = field(
@@ -54,11 +63,12 @@ class UPPBoundarySpec:
         default=UPPAggrSelector.MAX,
         validator=validators.instance_of(UPPAggrSelector),
     )
-    recapture_spec: RECConstants | None = field(
+
+    recapture_form: RECConstants | None = field(
         kw_only=True,
         default=RECConstants.INOUT,
         validator=(
-            validators.optional(validators.instance_of(RECConstants)),  # type: ignore
+            validators.instance_of((type(None), RECConstants)),
             _rec_spec_validator,
         ),
     )

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/src/mergeron/core/excel_helper.py

@@ -1,5 +1,5 @@
 """
-Routines for writing data from Python to fresh Excel workbooks using
+Methods for writing data from Python to fresh Excel workbooks using
 the third-party package, `xlsxwriter`.
 
 Includes a flexible system of defining cell formats.
@@ -27,6 +27,8 @@ __version__ = version(_PKG_NAME)
 class CFmtParent(dict[str, Any], enum.ReprEnum):  # type: ignore
     """Unique mappings defining xlsxwirter Workbook formats"""
 
+    ...
+
 
 class CFmt(CFmtParent):
     """

{mergeron-2024.738953.1 → mergeron-2024.738973.0}/src/mergeron/core/ftc_merger_investigations_data.py

@@ -1,5 +1,5 @@
 """
-Routines to parse FTC Merger Investigations Data, downloading source documents
+Methods to parse FTC Merger Investigations Data, downloading source documents
 as necessary
 
 NOTES
@@ -16,7 +16,6 @@ from pathlib import Path
 from types import MappingProxyType
 from typing import Any, NamedTuple, TypeAlias
 
-import fitz  # type: ignore
 import msgpack  # type: ignore
 import msgpack_numpy as m  # type: ignore
 import numpy as np
@@ -146,7 +145,7 @@ def construct_data(
                     )
         return MappingProxyType(_invdata)
 
-    _invdata = dict(parse_invdata())  # Convert immutable to mutable
+    _invdata = dict(_parse_invdata())  # Convert immutable to mutable
 
     # Add some data periods (
     #   only periods ending in 2011, others have few observations and
@@ -385,21 +384,9 @@ def _invdata_build_aggregate_table(
     )
 
 
-def parse_invdata(
-    _invdata_docnames: Sequence[str] = (
-        "040831horizmergersdata96-03.pdf",
-        "p035603horizmergerinvestigationdata1996-2005.pdf",
-        "081201hsrmergerdata.pdf",
-        "130104horizontalmergerreport.pdf",
-    ),
-) -> INVData:
+def _parse_invdata() -> INVData:
     """Parse FTC merger investigations data reports to structured data.
 
-    Parameters
-    ----------
-    _invdata_docnames
-        Names of PDF files reporting FTC merger investigations data.
-
     Returns
     -------
         Immutable dictionary of merger investigations data, keyed to
@@ -408,6 +395,16 @@ def parse_invdata(
         by range of HHI and ∆HHI.
 
     """
+    import fitz  # type: ignore
+    # user must install pymupdf to make this function operable
+
+    _invdata_docnames: Sequence[str] = (
+        "040831horizmergersdata96-03.pdf",
+        "p035603horizmergerinvestigationdata1996-2005.pdf",
+        "081201hsrmergerdata.pdf",
+        "130104horizontalmergerreport.pdf",
+    )
+
     _invdata: dict[str, dict[str, dict[str, INVTableData]]] = {}
 
     for _invdata_docname in _invdata_docnames: