Humanleague

Maintenance release, no functional changes.
- Minor updates for R packaging
- Updates to CI

New features (python only)

- most function outputs have changed to return a tuple of the main result and a dictionary containing the stats (if applicable), rather than a dictionary containing everything. For example, a return value that was previously:

py
{"result": r, "conv": ..., "rmse": ...}


now becomes

py
(r, {"conv": ..., "rmse": ...})


making it easier to access the result, e.g.:

py
result, stats = humanleague.integerise(p, n)


Removed features (python only)

- Remove deprecated `sobolSequence` function, in favour of the the `SobolSequence` generator introduced in 2.2.0
- conda-forge releases are no longer supported. Conda users should use pip to install the package.

Bug fixes

- fixed some documentation issues

Internal

- CI improvements: automated release pipeline PRs to main are automatically version bumped and published on pypi

New features

- deprecate `sobolSequence` function (python only), in favour of...
- add a `SobolSequence` generator for more flexibility (python only). You can replace code where you have to specify the length of the sequence upfront, and store the entire sequence in memory, like

py
dim = 3
length = 5
s = sobolSequence(dim, s) returns 5 3-d points in the sequence


with

py
s = SobolSequence(dim)
while some_condition:
v = next(s) returns the next 3-d point in the sequence


which is more flexible and can drastically reduce memory requirements.

Bug fixes

- Sobol sequence skip functionality now working as documented (previously was skipping twice as many values as it said it was)

**Full Changelog**: https://github.com/virgesmith/humanleague/compare/2.1.11...2.2.0

**maintenance release only, no functional change**

- fix some compiler warnings
- move R CI from appveyor to github

**python release only, no functional change**

- adds type annotations
- delete unused files from repo

**python release only, no functional change**

- fixes an issue with pinned `numpy` dependency version
- migrate some CI builds to github workflows
- add code coverage
- improve python build system