v0.3.0

v0.3.0 is a major update comprising one breaking change (see below).
Users are encouraged to update to this version.

Breaking Change

• Moved classes 'Case' and 'Parameter' from farn.farn to farn.core
  
  As a consequence, if you imported these classes in your code, you need to
  adapt the respective import statements. I.e.
  old

  from farn.farn import Case, Parameter

  new

  from farn.core import Case, Parameter

Added

• Added a 'Cases' class, acting as a container for Case instances.
  Cases inherits from List[Case] and can hence transparently be used as a Python list type.
  However, Cases provides additional convenience methods to export the attributes of all contained Case instances to a pandas DataFrame (Cases.to_pandas()) or to a numpy ndarray (Cases.to_numpy())
  Cases is located in the farn.core sub-package and can be imported from there, i.e:

  from farn.core import Case, Cases, Parameter

v0.2.7

Changed

• Linter: Migrated from flake8 to ruff.
  (Added ruff; removed flake8 and isort)
• Adjusted GitHub CI workflow accordingly.
  (Added ruff job; removed flake8 and isort jobs)
• VS Code settings: Adjusted Pylance configuration

Added

• Added a batch file 'qa.bat' in root folder to ease local execution of code quality checks

Dependencies

• updated to dictIO>=0.2.5 and ospx>=0.2.7

v0.2.6

Dependencies

• updated to ospx>=0.2.6

v0.2.5

Changed

• Moved dev-only dependencies from requirements.txt to requirements-dev.txt
• farn/__init__.py : ensured that imported symbols get also exported
  
  (added "as" clause -> "from x import y as y" instead of only "from x import y")
• sampling.py: refactored for cleaner code
• Configured code quality tools flake8, black, isort, pyright
• Improved code quality, resolving all warnings and errors flagged by the configured code quality tools
  (flake8, black, isort, pyright, sourcery)

Added

• Added GitHub workflow 'main.yml' for continuous integration (runs all CI tasks except Sphinx)
  • format checks: black, isort
  • lint check: flake8, flake8-bugbear
  • type check: pyright
  • test: uses tox to run pytest on {Windows, Linux, MacOS} with {py39, py310}
  • publish: publishing to PyPI (runs only on push of new tag vx.x.x, and after all other jobs succeeded)
  • merge_to_release_branch: merge tagged commit to release branch (runs after publish)

Dependencies

• updated to dictIO>=0.2.4

v0.2.4

Changed

• Code formatting: Changed from yapf to black
• STYLEGUIDE.md : Adjusted to match black formatting
• VS Code settings: Updated to use black as formatter
• requirements.txt: Updated dependencies to their most recent versions
• GitHub actions (yml files): Updated following actions to their most recent versions:
  • checkout@v1 -> checkout@v3
  • setup-python@v2 -> setup-python@v4
  • cache@v2 -> cache@v3

Added

• Added sourcery configuration (.sourcery.yaml)
• Added py.typed file into the package root folder and included it setup.cfg as package_data

v0.2.3

dependencies:

• upgraded to dictIO >= 0.2.2 (now supporting references and expressions in JSON dicts)
• upgraded to ospx >= 0.2.4
• changed from pyDOE>=0.3.8 to pyDOE2>=1.3.0

v0.2.2

Updated dependencies to ospx >= 0.2.3

v0.2.1

Updated dependencies to ospx >= 0.2.1 and dictIO >= 0.2.0

v0.2.0

Updated dependencies to ospx >= 0.2.0 and dictIO >= 0.1.2

v0.1.2

bumped version number to 0.1.2