changelog.yaml

- changes:
    added:
    - OpenFisca-Core forked.
  date: 2022-10-02 16:02:00
  version: 0.1.0
- bump: major
  changes:
    changed:
    - Non-essential (for Python simulations) code removed.
  date: 2022-10-02 16:35:17
- bump: patch
  changes:
    fixed:
    - Version update action.
  date: 2022-10-02 16:38:34
- bump: patch
  changes:
    fixed:
    - Push action doesn't attempt to publish nonexistent documentation.
  date: 2022-10-02 16:45:22
- bump: patch
  changes:
    fixed:
    - Build action always runs.
  date: 2022-10-02 16:59:49
- bump: patch
  changes:
    added:
    - Type hints to most functions and classes.
    - Jupyter book documentation for all modules.
  date: 2022-10-09 22:33:24
- bump: patch
  changes:
    added:
    - Test that documentation builds
  date: 2022-10-09 22:55:14
- bump: patch
  changes:
    fixed:
    - Python 3.9 used in all GitHub actions.
  date: 2022-10-09 23:00:35
- bump: minor
  changes:
    added:
    - Microsimulation features
    - Documentation for the CLI interface
  date: 2022-10-12 15:33:59
- bump: patch
  changes:
    added:
    - Behaviour to handle default datasets.
  date: 2022-10-12 15:58:34
- bump: patch
  changes:
    fixed:
    - Bug in the country template microsimulation class failing to load data.
  date: 2022-10-12 16:25:33
- bump: patch
  changes:
    fixed:
    - Git blame reassigns OpenFisca-Core authors.
  date: 2022-10-12 18:08:43
- bump: minor
  changes:
    added:
    - Parameter operations from openfisca-tools
    - Dataset classes from openfisca-tools
  date: 2022-10-14 10:14:40
- bump: minor
  changes:
    added:
    - Tests and documentation.
  date: 2022-10-14 17:18:21
- bump: minor
  changes:
    added:
    - Performance improvements
    - Import sorting and code health improvements
    fixed:
    - Axes now work in simulations
  date: 2022-10-18 15:28:22
- bump: patch
  changes:
    added:
    - Plotly to dependencies
  date: 2022-10-18 18:13:09
- bump: minor
  changes:
    added:
    - Branched simulations.
  date: 2022-10-19 16:01:51
- bump: minor
  changes:
    added:
    - Derivative calculation in simulations.
  date: 2022-10-19 22:44:19
- bump: minor
  changes:
    added:
    - Metadata dictionary input to Variables.
  date: 2022-10-21 12:39:50
- bump: minor
  changes:
    changed:
    - Parameter scale components now included in `get_descendants()`.
    fixed:
    - Folder paths in `Dataset`s are parsed as `Path`s.
    - Empty `input:` fields are parsed as `{}`.
  date: 2022-10-23 13:41:39
- bump: patch
  changes:
    removed:
    - Python 3.6 stated support.
  date: 2022-11-02 01:31:48
- bump: minor
  changes:
    fixed:
    - Various fixes for PolicyEngine's server app.
  date: 2022-11-08 15:00:26
- bump: minor
  changes:
    added:
    - Variables can now specify an 'uprating' parameter.
    - Variables can now specify 'adds' and 'subtracts' variable dependencies.
    - Variable folders are now automatically stored in a tree.
    fixed:
    - Bugs in cloned simulations.
  date: 2022-11-24 00:15:28
- bump: patch
  changes:
    added:
    - Documentation page on reforms.
    fixed:
    - Moved the uprating logic to after formulas are checked.
  date: 2022-11-24 00:33:05
- bump: patch
  changes:
    fixed:
    - Bug in defined-for causing it to be ignored.
    - Branched simulations now cache variables specifically for the branch and time
      period, not sharing with the parent simulation.
  date: 2022-11-27 14:33:53
- bump: patch
  changes:
    fixed:
    - Fixed a bug causing Windows tests to fail.
  date: 2022-11-27 16:08:33
- bump: patch
  changes:
    fixed:
    - Removed debug lines.
  date: 2022-11-27 16:16:29
- bump: patch
  changes:
    added:
    - Functionality for getting all known branch-period caches.
  date: 2022-11-28 10:37:23
- bump: patch
  changes:
    fixed:
    - README.md files in parameter trees now inform metadata.
  date: 2022-11-30 15:19:56
- bump: patch
  changes:
    fixed:
    - Various safety checks.
  date: 2022-11-30 20:33:21
- bump: patch
  changes:
    fixed:
    - Singleton files have a shorter moduleName.
  date: 2022-12-02 18:11:10
- bump: patch
  changes:
    fixed:
    - Bug with Enum decoding.
  date: 2022-12-03 15:21:15
- bump: patch
  changes:
    fixed:
    - Removed warning on Enum decoding.
  date: 2022-12-05 16:21:04
- bump: patch
  changes:
    fixed:
    - Include scale brackets in descendants.
  date: 2022-12-07 12:51:49
- bump: patch
  changes:
    fixed:
    - Uprating bug affecting the UK.
  date: 2022-12-07 13:41:29
- bump: patch
  changes:
    fixed:
    - Git config now ignores JetBrains IDE config files
  date: 2022-12-11 23:46:33
- bump: patch
  changes:
    fixed:
    - Added documentation on populating changelog entries. Also created a CONTRIBUTING.md
      symlink to make contributing guidelines easier to find.
  date: 2022-12-11 23:52:13
- bump: patch
  changes:
    added:
    - Hidden input field for variables.
  date: 2022-12-12 15:28:47
- bump: patch
  changes:
    added:
    - Added mypy to our test suite to prevent new type regressions
  date: 2022-12-13 23:40:47
- bump: patch
  changes:
    added:
    - Added `basic_inputs`, a metadata field for the basic inputs needed to get a
      country model running.
  date: 2022-12-14 15:33:46
- bump: patch
  changes:
    fixed:
    - Bugs with Enum inputs.
  date: 2022-12-15 15:27:35
- bump: patch
  changes:
    fixed:
    - Fixed mypy errors in tests/core/test_entities.py
  date: 2022-12-17 09:23:10
- bump: patch
  changes:
    fixed:
    - Fixed mypy errors in policyengine_core/tracers/tracing_parameter_node_at_instant.py
  date: 2022-12-17 16:36:53
- bump: patch
  changes:
    changed:
    - Removed seemingly unused "N_" function
  date: 2022-12-17 21:51:59
- bump: patch
  changes:
    added:
    - Fixed mypy errors in several files.
  date: 2022-12-18 06:07:32
- bump: patch
  changes:
    fixed:
    - Fix incorrect type annotation in policyengine_core/variables/variable.py
  date: 2022-12-18 06:12:52
- bump: patch
  changes:
    changed:
    - Pin all package versions.
  date: 2023-01-02 20:40:49
- bump: minor
  changes:
    added:
    - Adds/subtracts option for parameter names.
  date: 2023-01-03 20:50:02
- bump: patch
  changes:
    added:
    - A metadata option to specify which policies are modelled and not modelled.
  date: 2023-01-04 12:51:00
- bump: patch
  changes:
    added:
    - Error message for an unknown variable.
  date: 2023-01-04 13:05:49
- bump: patch
  changes:
    removed:
    - aggr function, which is superseded by add.
  date: 2023-01-10 17:32:23
- bump: patch
  changes:
    fixed:
    - Labels and names aren't propagated in parameters.
  date: 2023-01-11 23:44:12
- bump: minor
  changes:
    added:
    - Likely high time savings for simulations making heavy usage of reforms and branches.
  date: 2023-01-27 22:28:10
- bump: patch
  changes:
    added:
    - Abolition parameters for each variable under `gov.abolitions`.
  date: 2023-01-28 15:58:38
- bump: patch
  changes:
    added:
    - Option for loading non-year-specific datasets.
  date: 2023-02-09 21:59:16
- bump: patch
  changes:
    fixed:
    - Branches stay persistent between variables.
  date: 2023-03-04 22:58:51
- bump: patch
  changes:
    fixed:
    - Removed bad dependency fixes.
  date: 2023-03-08 21:35:17
- bump: major
  changes:
    changed:
    - Datasets API simplified and made more consistent.
  date: 2023-03-23 02:37:29
- bump: patch
  changes:
    fixed:
    - A bug where public datasets would fail to download.
  date: 2023-03-23 08:55:46
- bump: patch
  changes:
    changed:
    - Added ability to pull datasets from GitHub releases.
  date: 2023-03-31 18:27:52
- bump: patch
  changes:
    changed:
    - Removed node homogenuity check for speed.
  date: 2023-04-14 10:06:10
- bump: patch
  changes:
    fixed:
    - Bug causing simulations containing multiple group entities and axes to fail
      to simulate.
  date: 2023-05-23 07:35:11
- bump: minor
  changes:
    added:
    - Python 3.10 support.
    fixed:
    - PyTest syntax updated.
  date: 2023-05-23 13:22:04
- bump: patch
  changes:
    fixed:
    - Fixed pytest deprecated usages since version 7, and fixed a bug that prevented
      new package from publishing.
  date: 2023-05-24 15:11:39
- bump: minor
  changes:
    fixed:
    - Bug causing unhelpful errors when variables are not found.
  date: 2023-05-31 11:11:09
- bump: patch
  changes:
    fixed:
    - A bug causing variable not found errors to sometimes fail to throw.
  date: 2023-06-02 15:22:29
- bump: minor
  changes:
    added:
    - Optional argument for saving datasets to a specific file path.
    - Safety check for Path objects not being strings.
  date: 2023-06-30 08:22:27
- bump: minor
  changes:
    added:
    - Chart formatting utilities.
  date: 2023-07-21 14:55:15
- bump: minor
  changes:
    added:
    - Chart formatting utilities.
  date: 2023-08-02 12:54:44
- bump: minor
  changes:
    fixed:
    - Bump numpy version
    - Fix numpy record compatibility issue
  date: 2023-10-04 14:51:40
- bump: minor
  changes:
    added:
    - Automatic period adjustment helper functionality.
    changed:
    - Default error threshold for tests widened to 1e-3.
  date: 2023-10-04 19:05:58
- bump: patch
  changes:
    fixed:
    - Fix bug affecting microsimulation runs in countries which use automatic period
      adjustments.
  date: 2023-10-05 11:00:40
- bump: minor
  changes:
    added:
    - Support for adds/subtracts targeting parameters.
    - Support for adds/subtracts targeting year ranges where no parameters exist.
    changed:
    - Deprecated sum_of_variables.
  date: 2023-10-05 11:41:53
- bump: patch
  changes:
    fixed:
    - Bug causing YAML tests to not populate `Simulation.input_variables`.
  date: 2023-10-05 13:24:20
- bump: patch
  changes:
    changed:
    - Unpinned lower NumPy pin.
  date: 2023-10-09 17:52:02
- bump: minor
  changes:
    added:
    - PolicyEngine API integration for reforms.
  date: 2023-11-12 13:23:23
- bump: minor
  changes:
    fixed:
    - Reforms always apply before parameter utilities.
  date: 2023-11-22 15:05:43
- bump: minor
  changes:
    fixed:
    - Reforms always apply before parameter utilities.
  date: 2023-11-22 15:55:52
- bump: patch
  changes:
    fixed:
    - Bug causing `subtracts` to not accept strings.
  date: 2023-11-30 18:45:01
- bump: patch
  changes:
    fixed:
    - Bug causing random behaviour differences between situations with and without
      axes.
  date: 2023-12-14 11:38:52
- bump: patch
  changes:
    fixed:
    - Random seed fixed for each simulation.
  date: 2023-12-16 15:34:37
- bump: patch
  changes:
    added:
    - Tools for branching
  date: 2023-12-19 11:12:24
- bump: patch
  changes:
    fixed:
    - Randomness issue.
  date: 2023-12-21 10:55:47
- bump: minor
  changes:
    added:
    - API ID to reform object functionality.
  date: 2023-12-26 18:31:31
- bump: patch
  changes:
    fixed:
    - API to reform functionality made more editable.
  date: 2023-12-27 13:28:08
- bump: minor
  changes:
    added:
    - Simulation helper to extract individual households from a microsimulation.
  date: 2024-01-02 15:26:52
- bump: patch
  changes:
    added:
    - Improvements to error handling in bad variable declarations.
  date: 2024-02-06 11:28:22
- bump: minor
  changes:
    changed:
    - A variable must have a label.
    - If a variable has formulas then it must not have adds/subtracts, and vice versa.
  date: 2024-02-06 17:28:06
- bump: minor
  changes:
    added:
    - Variable inheritance in declarations.
  date: 2024-02-08 14:32:38
- bump: minor
  changes:
    removed:
    - Error raising for adds/subtracts properties plus a formula.
  date: 2024-02-14 14:49:15
- bump: patch
  changes:
    fixed:
    - Fixed a bug in Core monthlyisation.
  date: 2024-02-29 16:03:09
- bump: minor
  changes:
    changed:
    - Add method for propagating units to descendants for ParameterScale objects
  date: 2024-03-04 11:27:40
- bump: patch
  changes:
    fixed:
    - Breakdown-added parameters no longer precede uprating indices.
  date: 2024-03-05 13:01:42
- bump: minor
  changes:
    added:
    - Parameters can now be uprated based upon fixed cadences
  date: 2024-03-22 10:42:19
- bump: minor
  changes:
    added:
    - Baseline parameter node.
  date: 2024-04-16 12:51:42
- bump: patch
  changes:
    fixed:
    - FutureWarning issue with bools and enums.
  date: 2024-04-29 15:06:58
- bump: patch
  changes:
    added:
    - IPython to dependencies
  date: 2024-05-06 12:47:34
- bump: minor
  changes:
    added:
    - Macro impact caching.
    - Dictionary-input start-stop date reform handling.
    fixed:
    - Uprating bugs.
  date: 2024-05-06 14:24:08
- bump: minor
  changes:
    added:
    - Ability to turn off read and write features in the macro cache.
  date: 2024-05-07 12:16:05
- bump: patch
  changes:
    fixed:
    - Bug in macro caching logic.
  date: 2024-05-07 15:44:58
- bump: patch
  changes:
    fixed:
    - Generation of enum-typed variables
  date: 2024-05-08 08:44:48
- bump: patch
  changes:
    added:
    - Dependency upgrade for pytest, from 7 to 8.
  date: 2024-05-08 13:36:00
- bump: patch
  changes:
    added:
    - Added `.vscode` and `venv` to `.gitignore` file.
    removed:
    - Removed `.vscode` folder from the repository.
  date: 2024-05-08 13:39:53
- bump: patch
  changes:
    fixed:
    - Bug in macro cache logic.
  date: 2024-05-08 15:07:51
- bump: patch
  changes:
    changed:
    - Replaced unsafe numpy-Python comparison with use of numpy dtype to convert byte-string
      arrays to Unicode ones within enums
  date: 2024-05-13 16:26:53
- bump: patch
  changes:
    fixed:
    - Remove name metadata tag in docs.
  date: 2024-05-14 15:27:27
- bump: patch
  changes:
    fixed:
    - Uncap coverage.
  date: 2024-05-14 15:33:07
- bump: minor
  changes:
    fixed:
    - Bug causing reforms affecting data to not affect caches.
  date: 2024-05-31 11:12:13
- bump: minor
  changes:
    added:
    - max_value and min_value in Variable class.
  date: 2024-06-04 19:43:13
- bump: patch
  changes:
    added: Visualization option when running tests
  date: 2024-06-06 09:09:41
- bump: major
  changes:
    changed:
    - Added support for Python 3.12
  date: 2024-06-26 17:08:24
- bump: minor
  changes:
    added:
    - Flat file dataset option.
    - Microdata weighting classes from microdf.
    - Eternity dictionary reform options.
  date: 2024-07-26 00:28:31
- bump: minor
  changes:
    changed:
    - Reform syntax to increase flexibility.
  date: 2024-07-28 19:28:05
- bump: minor
  changes:
    added:
    - Simulation loading from dataframes.
    - Simulation `start_instant` attribute.
  date: 2024-08-02 09:09:51
- bump: minor
  changes:
    added:
    - Flat file export option to simulations.
  date: 2024-08-07 12:42:36
- bump: minor
  changes:
    removed:
    - Removed nptyping, migrated to numpy.typing
  date: 2024-08-08 15:16:12
- bump: patch
  changes:
    fixed:
    - fixed bug where uprating was causing nan.
  date: 2024-08-08 15:17:05
- bump: patch
  changes:
    changed:
    - change mypy version from 1.11.1 to <2
  date: 2024-08-17 19:28:38
- bump: patch
  changes:
    changed:
    - Fixed script to initialize a reform within the simulation
  date: 2024-08-21 14:34:52
- bump: minor
  changes:
    fixed:
    - Bugs in typing and Dataset saving.
  date: 2024-08-28 16:41:26
- bump: patch
  changes:
    added:
    - Added class SimulationMacroCache for macro simulation caching purposes.
  date: 2024-08-31 16:13:07
- bump: patch
  changes:
    added:
    - Added class SimulationMacroCache for macro simulation caching purposes.
  date: 2024-09-02 13:04:21
- bump: patch
  changes:
    fixed:
    - Syntax error in Simulation class
  date: 2024-09-02 22:01:19
- bump: patch
  changes:
    changed:
    - Ensure that every instance of 'Simulation' class has 'dataset' attribute, even
      if equal to 'None'
    - Add better safeguards to 'check_macro_cache' method of 'Simulation' class
  date: 2024-09-03 18:42:55
- bump: patch
  changes:
    fixed:
    - Corrected logic with Simulation.check_macro_cache to prevent undesirable caching
  date: 2024-09-04 21:19:20
- bump: patch
  changes:
    changed:
    - Disable macro cache by default.
  date: 2024-09-09 13:52:47
- bump: minor
  changes:
    added:
    - Simulation subsampling.
  date: 2024-09-24 18:10:25
- bump: patch
  changes:
    changed:
    - Renamed sim_macro_cache.py to simulation_macro_cache.py
  date: 2024-09-26 00:13:13
- bump: minor
  changes:
    added:
    - Randomness based on entity IDs as seeds.
    - OpenFisca-Core imports.
  date: 2024-09-26 12:00:25
- bump: patch
  changes:
    changed:
    - Set test runner's default period as underlying simulation's default period
    - Prevented crashing when absolutely no date is provided anywhere for tests
  date: 2024-09-27 10:43:12
- bump: patch
  changes:
    changed:
    - Updated README.md
  date: 2024-10-01 19:33:10
- bump: minor
  changes:
    changed:
    - Shallow copy entities between TaxBenefitSystem objects when cloning
  date: 2024-10-09 20:29:35
- bump: minor
  changes:
    added:
    - Two tests related to extensions that were previously removed
    changed:
    - Shallow copy GroupEntities and PopulationEntity when cloning TaxBenefitSystem
      object
  date: 2024-10-17 15:59:10
- bump: minor
  changes:
    fixed:
    - Bug causing subsample to not work in some situations.
  date: 2024-10-24 11:04:12
- bump: patch
  changes:
    changed:
    - Replace custom implementation of microdf with deployed version
  date: 2024-10-29 20:04:02
- bump: minor
  changes:
    changed:
    - update the ipython requirement to version 8
  date: 2024-10-30 18:46:15
- bump: patch
  changes:
    fixed:
    - Bug causing Enums to fail in some simulations.
  date: 2024-11-01 11:36:53
- bump: patch
  changes:
    added:
    - Compatibility settings for editable installs
  date: 2024-11-01 21:39:35
- bump: patch
  changes:
    fixed:
    - Bug in labour supply responses.
  date: 2024-11-04 16:29:34
- bump: patch
  changes:
    fixed:
    - Datasets writing downloaded data now use an atomic_write to write it to disk.
      This prevents other processes attempting to read a partial file or clobbering
      each other.
  date: 2024-11-11 14:20:12
- bump: patch
  changes:
    changed:
    - update the psutil requirement to version 6
    - update the furo requirment to <2025
    - update the markupsafe requirement to <3
  date: 2024-11-20 13:13:13
- bump: minor
  changes:
    added:
    - HuggingFace upload/download functionality.
  date: 2024-11-27 13:12:44
- bump: minor
  changes:
    added:
    - Support for HuggingFace-hosted H5 file inputs.
  date: 2024-11-29 16:08:25
- bump: patch
  changes:
    changed:
    - Replaced coexistent standard/HuggingFace URL with standalone URL parameter
    - Fixed bugs in download_from_huggingface() method
    - Create utility function for pulling HuggingFace env var
  date: 2024-12-02 16:35:14
- bump: minor
  changes:
    added:
    - Chained reform handling in TaxBenefitSystems.
  date: 2024-12-05 14:47:01
- bump: minor
  changes:
    changed:
    - Refactor all Hugging Face downloads to use the same download function
    - Attempt to determine whether a token is necessary before downloading from Hugging
      Face
    - Add tests for this new functionality
  date: 2024-12-18 15:12:25
- bump: patch
  changes:
    changed:
    - Explicitly set local directory when downloading datasets from Hugging Face
  date: 2024-12-20 12:56:31