Compute Studio criteria and api changes

[hdoupe]

Criteria Changes:

• New Function: get_version

  • This should return a string representing your model's version.

• New return format for get_inputs:

  • This should return a dictionary: {"meta_parameters": {...}, "model_parameters": {...}}
  • The meta_parameters defaults and the defaults for each section in model_parameters should be ParamTools compliant, i.e. they can be loaded from paramtools.Parameters.
  • A new method was added to Parameters in ParamTools 0.10.0 called dump which returns data meeting this requirement. Projects that use labels like "year" should set the state of the Parameters instance using params.set_state(year=new_year) before calling dump. Here is the diff for Tax-Brain to demonstrate these changes: https://github.com/PSLmodels/Tax-Brain/compare/master...hdoupe:cs-update?diff=split&expand=1#diff-505483cbd6a368c1f63d1be32ed360bfL50

• New return format for validate_inputs:

  • This should return a dictionary: {"errors_warnings": {...}, "custom_adjustment: {...}}
  • "custom_adjustment" is optional. Projects that do not use ParamTools for their inputs may use "custom_adjustment" to return data in their native inputs format.

• Function run_model should not include "model_version" in its results since that information is available in the new get_version function.

Package name changes:

• pip install compdevkit --> pip install cs-kit
• import compdevkit --> import cs_kit
• import compconfig --> import cs_config
• cdk-init --> csk-init
  • Creates file structure:

    $ csk-init
    $ tree cs-config/
    cs-config/
    ├── cs_config
    │   ├── functions.py
    │   ├── __init__.py
    │   └── tests
    │       ├── __init__.py
    │       └── test_functions.py
    ├── install.sh
    └── setup.py

Tests API Changes:

compute-studio-kit now uses a test class that integrates better with pytest. Define your tests like this (of course, csk-init will write a template in test_functions.py to help you get started):

class TestFunctions1(CoreTestFunctions):
    get_version = functions.get_version
    get_inputs = functions.get_inputs
    validate_inputs = functions.validate_inputs
    run_model = functions.run_model
    ok_adjustment = OK_ADJUSTMENT
    bad_adjustment = BAD_ADJUSTMENT

This produces output:

(taxbrain-dev) hdoupe@pop-os:~/Documents/Tax-Brain$ py.test cs-config/ -v
==================================================== test session starts =====================================================
platform linux -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.13.0 -- /home/hdoupe/anaconda3/envs/taxbrain-dev/bin/python
cachedir: .pytest_cache
rootdir: /home/hdoupe/Documents/Tax-Brain/cs-config
collected 12 items                                                                                                           

cs-config/cs_config/tests/test_functions.py::TestFunctions1::test_all_data_specified PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions1::test_get_version PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions1::test_get_inputs PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions1::test_validate_inputs PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions1::test_run_model PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions2::test_all_data_specified PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions2::test_get_version PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions2::test_get_inputs PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions2::test_validate_inputs PASSED
cs-config/cs_config/tests/test_functions.py::TestFunctions2::test_run_model PASSED
cs-config/cs_config/tests/test_functions.py::test_convert_adj PASSED
cs-config/cs_config/tests/test_functions.py::test_convert_adj_w_index PASSED

====================================================== warnings summary ======================================================
...
========================================= 12 passed, 6 warnings in 679.15s (0:11:19) =========================================
(taxbrain-dev) hdoupe@pop-os:~/Documents/Tax-Brain$ py.test cs-config/ -v

[hdoupe]

These changes were implemented in PR #3. This issue will remain open while projects are swapping over to the new API and criteria.