mergeron 2024.738930.0__tar.gz → 2024.738936.2__tar.gz

{mergeron-2024.738930.0 → mergeron-2024.738936.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.738930.0
+Version: 2024.738936.2
 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
@@ -57,44 +57,41 @@ 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.
 
-    :code:`mergeron.core.ftc_merger_investigations_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.
 
-    :code:`mergeron.core.guidelines_standards`
+    mergeron.core.guidelines_standards
 
 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.
 
-    :code:`mergeron.gen.data_generation`
+    mergeron.gen.data_generation
 
 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.
 
-    :code:`mergeron.gen.guidelines_tests`
+    mergeron.gen.guidelines_tests
 
-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.invstigations_stats`.
+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.
 
-    :code:`mergeron.examples`
+    mergeron.examples
 
-This package also 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:
+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:`import mergeron.core.pseudorandom_numbers as prng`
+    import mergeron.core.pseudorandom_numbers as prng
 
-Also included are routines for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (These are a subset of routines available from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/), in the module, :code:`statsmodels.stats.proportion`, with selective modifications. To access these directly:
+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:
 
-    :code:`import mergeron.core.proportions_tests as prci`
+    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:`import mergeron.ext.tol_colors`
-
-Documentation for this package is in the form of the API Reference. For individual functions and classes, this same documentation is accessible within a python shell. For example, the below snippet produces the API reference for the given function in a python::
-
-        import mergeron.core.data_generation as dgl
-        help(dgl.gen_market_sample)
-
+    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:
 
+    import mergeron.core.data_generation as dgl
 
+    help(dgl.gen_market_sample)
 

{mergeron-2024.738930.0 → mergeron-2024.738936.2}/README.rst

@@ -10,43 +10,40 @@ 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.
 
-    :code:`mergeron.core.ftc_merger_investigations_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.
 
-    :code:`mergeron.core.guidelines_standards`
+    mergeron.core.guidelines_standards
 
 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.
 
-    :code:`mergeron.gen.data_generation`
+    mergeron.gen.data_generation
 
 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.
 
-    :code:`mergeron.gen.guidelines_tests`
+    mergeron.gen.guidelines_tests
 
-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.invstigations_stats`.
+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.
 
-    :code:`mergeron.examples`
+    mergeron.examples
 
-This package also 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:
+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:`import mergeron.core.pseudorandom_numbers as prng`
+    import mergeron.core.pseudorandom_numbers as prng
 
-Also included are routines for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (These are a subset of routines available from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/), in the module, :code:`statsmodels.stats.proportion`, with selective modifications. To access these directly:
+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:
 
-    :code:`import mergeron.core.proportions_tests as prci`
+    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:`import mergeron.ext.tol_colors`
-
-Documentation for this package is in the form of the API Reference. For individual functions and classes, this same documentation is accessible within a python shell. For example, the below snippet produces the API reference for the given function in a python::
-
-        import mergeron.core.data_generation as dgl
-        help(dgl.gen_market_sample)
-
+    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:
 
+    import mergeron.core.data_generation as dgl
 
+    help(dgl.gen_market_sample)

{mergeron-2024.738930.0 → mergeron-2024.738936.2}/pyproject.toml

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

{mergeron-2024.738930.0/src/mergeron/gen → mergeron-2024.738936.2/src/mergeron/core}/__init__.py

@@ -1,5 +1,5 @@
 from importlib.metadata import version
 
-from .. import _PKG_NAME
+from .. import _PKG_NAME  # noqa: TID252
 
 __version__ = version(_PKG_NAME)