Rewrite conda package generation, clean up additional files. (#340)

Author: tobiasraabe

bld.bat .conda/bld.bat

@@ -1,2 +1,2 @@
-"%PYTHON%" setup.py install
-if errorlevel 1 exit 1
+"%PYTHON%" setup.py install
+if errorlevel 1 exit 1

build.sh .conda/build.sh

@@ -0,0 +1,44 @@
+{% set data = load_setup_py_data() %}
+
+package:
+  name: respy
+  version: {{ data.get('version') }}
+
+source:
+  path: ../../respy
+
+build:
+  noarch: python
+
+requirements:
+  build:
+    - python
+    - setuptools
+
+  run:
+    - python >=3.6,<=3.7
+    - chaospy
+    - click
+    - estimagic >=0.0.27
+    - joblib
+    - mkl
+    - numba >=0.42
+    - numpy
+    - pandas >=0.24
+    - pytest
+    - pyyaml
+    - scipy
+test:
+  commands:
+    - pytest
+  source_files:
+    - respy
+    - tox.ini
+
+about:
+  home: {{ data.get('url') }}
+  license: {{ data.get('license') }}
+  license_file: LICENSE
+  summary: {{ data.get('description') }}
+  dev_url: https://github.com/OpenSourceEconomics/respy
+  doc_url: {{ data.get('url') }}

.conda/meta.yaml

@@ -16,6 +16,3 @@ pytestdebug.log
 *.sublime-project
 *.sublime-workspace
 *.egg-info
-
-**/*.pbs
-**/*.respy.*

.gitignore

@@ -47,7 +47,7 @@ repos:
         files: '(README.rst)'
         name: restructuredtext-lint - Is the README PyPi-compliant?
 # -   repo: https://github.com/mgedmin/check-manifest
-#     rev: "0.39"
+#     rev: '0.41'
 #     hooks:
 #     -   id: check-manifest
 -   repo: meta

.pre-commit-config.yaml

@@ -2,20 +2,19 @@ The MIT License (MIT)
 
 Copyright (c) 2015-2020
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following
+conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
+OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

.readthedocs.yml .readthedocs.yaml

@@ -8,22 +8,20 @@
 
 include CHANGES.rst
 include CITATION
-include Dockerfile
 include LICENSE
 include README.rst
 include tox.ini
 include *.sh
 include *.yaml
 include *.yml
 
-graft docs
+graft .conda
 graft respy
 
-prune .binder
 prune development
-prune docs/_build
-prune docs/getting_started/__tutorial__
+prune docs
 
 global-exclude __pycache__
+global-exclude .ipynb_checkpoints
 global-exclude *.py[co]
 global-exclude *-checkpoint.ipynb

CITATION

@@ -41,3 +41,18 @@ You can install ``respy`` via conda with
 
 Please visit our `online documentation <https://respy.readthedocs.io/en/latest/>`_ for
 tutorials and other information.
+
+
+Citation
+--------
+
+If you use respy for your research, do not forget to cite it with
+
+.. code-block::
+
+    @Unpublished{The respy Team,
+      Title  = {respy - A Framework for the Estimation of some DCDP Models.},
+      Author = {The respy Team},
+      Year   = {2015},
+      Url    = {https://github.com/OpenSourceEconomics/respy},
+    }

Dockerfile

@@ -5,12 +5,11 @@
 import click
 import numpy as np
 
-import respy as rp
 from respy.config import TEST_RESOURCES_DIR
 from respy.config import TOL_REGRESSION_TESTS
 from respy.tests.random_model import generate_random_model
-from respy.tests.random_model import simulate_truncated_data
-
+from respy.tests.test_regression import compute_log_likelihood
+from respy.tests.test_regression import load_regression_tests
 
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 
@@ -29,15 +28,6 @@ def _prepare_message(idx_failures):
     return subject, message
 
 
-def calc_crit_val(params, options):
-    df = simulate_truncated_data(params, options)
-
-    crit_func = rp.get_crit_func(params, options, df)
-    crit_val = crit_func(params)
-
-    return crit_val
-
-
 def run_regression_tests(n_tests, strict, notification):
     """Run regression tests.
 
@@ -88,20 +78,12 @@ def create_regression_tests(n_tests, save):
             pickle.dump(tests, p)
 
 
-def load_regression_tests():
-    """Load regression tests from disk."""
-    with open(TEST_RESOURCES_DIR / "regression_vault.pickle", "rb") as p:
-        tests = pickle.load(p)
-
-    return tests
-
-
 def investigate_regression_test(idx):
     """Investigate regression tests."""
     tests = load_regression_tests()
     params, options, exp_val = tests[idx]
 
-    crit_val = calc_crit_val(params, options)
+    crit_val = compute_log_likelihood(params, options)
 
     assert np.isclose(
         crit_val, exp_val, rtol=TOL_REGRESSION_TESTS, atol=TOL_REGRESSION_TESTS
@@ -113,7 +95,7 @@ def _check_single(test, strict):
     params, options, exp_val = test
 
     try:
-        crit_val = calc_crit_val(params, options)
+        crit_val = compute_log_likelihood(params, options)
         is_success = np.isclose(
             crit_val, exp_val, rtol=TOL_REGRESSION_TESTS, atol=TOL_REGRESSION_TESTS
         )
@@ -132,7 +114,7 @@ def _create_single(idx):
 
     params, options = generate_random_model()
 
-    crit_val = calc_crit_val(params, options)
+    crit_val = compute_log_likelihood(params, options)
 
     if not isinstance(crit_val, float):
         raise AssertionError(" ... value of criterion function too large.")