Merge pull request #25 from rickecon/newenv

merging
EAPD-DRB · Jan 9, 2023 · b478323 · b478323
2 parents 7a7f6c9 + 33650f9
commit b478323
Show file tree

Hide file tree

Showing 6 changed files with 182 additions and 107 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
-[![Python 3.7+](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/release/python-377/)
+[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-3916/)
+[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3108/)
+![example event parameter](https://github.com/EAPD-DRB/OG-ZAF/actions/workflows/deploy_docs.yml/badge.svg?branch=main)
+![example event parameter](https://github.com/EAPD-DRB/OG-ZAF/actions/workflows/check_black.yml/badge.svg?branch=main)
 
 # OG-ZAF
 OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for South Africa. OG-ZAF is built on the OG-Core framework. The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available at https://pslmodels.github.io/OG-Core and documentation of the specific South African calibration of the model will be available soon.
@@ -12,15 +15,9 @@ OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general
   * Make sure the `conda` package manager is up-to-date: `conda update conda`.
   * Make sure the Anaconda distribution of Python is up-to-date: `conda update anaconda`.
 * Fork this repository and clone your fork of this repository to a directory on your computer.
-* **If you are installing this on a M1/M2 Mac (ARM):**
-  * From the terminal (or Anaconda command prompt), navigate to the directory to which you cloned this repository and run `conda env create -f environment-M1.yml`. The process of creating the `ogzaf-dev` conda environment should not take more than five minutes.
-  * Then, `conda activate ogzaf-dev`
-  * Then, `pip install --no-dependencies ogcore`
-  * Then install by `pip install -e .`
-* **If you are installing this on a Windows or Intel Mac:**
-  * From the terminal (or Anaconda command prompt), navigate to the directory to which you cloned this repository and run `conda env create -f environment.yml`. The process of creating the `ogzaf-dev` conda environment should not take more than five minutes.
-  * Then, `conda activate ogzaf-dev`
-  * Then install by `pip install -e .`
+* From the terminal (or Anaconda command prompt), navigate to the directory to which you cloned this repository and run `conda env create -f environment.yml`. The process of creating the `ogzaf-dev` conda environment should not take more than five minutes.
+* Then, `conda activate ogzaf-dev`
+* Then install by `pip install -e .`
 ### Run an example of the model
 * Navigate to `./examples`
 * Run the model with an example reform from terminal/command prompt by typing `python run_og_zaf.py`

diff --git a/environment-M1.yml b/environment-M1.yml
diff --git a/environment.yml b/environment.yml
@@ -2,11 +2,13 @@ name: ogzaf-dev
 channels:
 - conda-forge
 dependencies:
-- python>=3.7.7, <=3.9.12  # This restriction can be removed as soon as these packages support Python 3.10
-- mkl>=2020.2  
-- numpy<=1.21.2  # This restriction can be removed as soon as Numba supports NumPy 1.22
+- python>=3.7.7, <=3.11  # This restriction can be removed as soon as these packages support Python 3.10
+- ipython
+- setuptools
 - psutil
-- scipy>=1.5.0
+- openssl=1.1.1  # This is a requirement of the UN data portal which we are using in demographics.py
+- numpy<=1.21.2  # This restriction can be removed as soon as Numba supports NumPy 1.22
+- scipy>=1.7.1
 - pandas>=1.2.5
 - matplotlib
 - dask>=2.30.0

diff --git a/setup.py b/setup.py
@@ -1,40 +1,60 @@
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
+import setuptools
 
-with open("README.md") as f:
-    longdesc = f.read()
+with open("README.md", "r", encoding="utf-8") as fh:
+    longdesc = fh.read()
 
-version = "0.0.0"
-
-config = {
-    "description": "South Africa Calibration for OG-Core",
-    "long_description": longdesc,
-    "url": "https://github.com/EAPD-DRB/OG-ZAF/",
-    "download_url": "https://github.com/EAPD-DRB/OG-ZAF/",
-    "version": version,
-    "license": "CC0 1.0 Universal public domain dedication",
-    "packages": ["ogzaf"],
-    "include_package_data": True,
-    "name": "ogzaf",
-    "install_requires": [],
-    "package_data": {"ogzaf": ["data/*"]},
-    "classifiers": [
+setuptools.setup(
+    name="ogzaf",
+    version="0.0.0",
+    author="Marcelo LaFleur and Richard W. Evans",
+    license="CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+    description="South Africa Calibration for OG-Core",
+    long_description_content_type="text/markdown",
+    long_description=longdesc,
+    url="https://github.com/EAPD-DRB/OG-ZAF/",
+    download_url="https://github.com/EAPD-DRB/OG-ZAF/",
+    project_urls={
+        "Issue Tracker": "https://github.com/EAPD-DRB/OG-ZAF/issues",
+    },
+    packages=["ogzaf"],
+    package_data={
+        "ogzaf": [
+            "ogzaf_default_parameters.json",
+            "data/*",
+        ]
+    },
+    include_packages=True,
+    python_requires=">=3.7.7, <3.11",
+    install_requires=[
+        "psutil",
+        "openssl=1.1.1",
+        "numpy<=1.21.2",
+        "scipy>=1.7.1",
+        "pandas>=1.2.5",
+        "matplotlib",
+        "dask>=2.30.0",
+        "distributed>=2.30.1",
+        "paramtools>=0.15.0",
+        "requests",
+        "xlwt",
+        "openpyxl",
+        "statsmodels",
+        "linearmodels",
+        "black",
+        "pandas-datareader",
+        "ogcore",
+    ],
+    classifiers=[
         "Development Status :: 2 - Pre-Alpha",
         "Intended Audience :: Developers",
         "Natural Language :: English",
-        "License :: OSI Approved :: CC0 1.0 Universal public domain dedication",
+        "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    "tests_require": ["pytest"],
-}
-
-setup(**config)
+    tests_require=["pytest"],
+)