Changelog

Changelog#

Version 0.4.0#

Released on: 2025/08/14

doi: https://doi.org/10.5281/zenodo.16874959

Bug fixes:

  • Fix bug in spacing_to_size when start == stop. We’d expect that the size returned would be 1 (a single point) but it was returning 2 instead because of a fix to another bug. (#62)

New functions:

  • Add function random_coordinates_spherical to generate random points on a sphere following a uniform distribution. Using the regular random_coordinates leads to larger concentration of points at the poles. (#59)

  • Add function rolling_window_spherical to generate rolling windows of roughly equal area on a sphere. It accounts for the convergence of longitude lines by increasing the longitudinal size of windows when needed and is able to wrap windows around the 360-0 longitude divide. (#58)

Documentation:

  • Fix description of step in rolling window docs (#57)

This release contains contributions from:

  • Leonardo Uieda

Version 0.3.0#

Released on: 2025/05/15

doi: https://doi.org/10.5281/zenodo.15427887

Breaking changes:

  • Remove validation functions check_coordinates, check_region, and check_shape from the public API because they will tend to be specific to individual projects, causing compatibility problems for us when our requirements change (#49)

New functions:

  • Add function great_circle_coordinates to make points at regular distances along a great circle on a sphere (#50)

  • Add and expand to n-dimenions the function profile_coordinates from Verde to generate evenly spaced points between two reference points points (#48)

  • Add function neighbor_distance_statistics to calculate statistics of the distances to nearest neighbors of points. This is a generalization of the function median_distance from Verde (#46)

  • Add and expand function shape_to_spacing from Verde to convert a shape (numbers of points) to spacings (#44)

  • Make function spacing_to_size public in the API instead of private (#43)

Improvements:

  • Add check for invalid size argument in line_coordinates (#47)

Documentation:

  • Add an Overview page to the documentation that covers basic functionality and explains a bit about what the package does (#51)

Maintenance:

  • Specify coverage source in pyproject.toml (#42)

This release contains contributions from:

  • Leonardo Uieda

Version 0.2.0#

Released on: 2025/05/08

doi: https://doi.org/10.5281/zenodo.15360679

Breaking changes:

  • Rename the rng argument of bordado.random_coordinates to random_seed, which is more explicit and won’t be confused with “range” (#34)

New functions ported from Verde and improved:

  • New function bordado.expanding_window to split points with n dimensions on windows that share a common center but expand in size (#37)

Enhancements:

  • Make sure bordado.get_region works with pandas and xarray inputs (#36)

Maintenance:

  • Pin third-party Actions using commit hashes instead of tags for security (#39)

This release contains contributions from:

  • Santiago Soler

  • Leonardo Uieda

Version 0.1.0#

Released on: 2025/03/28

doi: https://doi.org/10.5281/zenodo.15102594

The functions below are originally from the Verde library and have been moved here and improved upon:

  • Add function rolling_window to split points into rolling windows (#31)

  • Add function block_split to split points into blocks (#30)

  • Add function grid_coordinates to generate n-dimensional grids with evenly spaced points (#18)

  • Add function random_coordinates to make a random scatter of points in n-dimensions (#25 and #26)

  • Add function inside to check which points are in a region (#24)

  • Add function get_region to get the bounding box of the given set of coordinates (#16)

  • Add function pad_region to expand a region by a specified amount (#15)

  • Add function line_coordinates to generate 1D evenly-spaced coordinates (#13)

Improvements over their Verde counterparts:

  • All functions now work with more than 2 dimensions.

  • Argument names have been changed to make them more reasonable, for example spacing in block_split was renamed to block_size.

  • Functions perform more sanity checks on their arguments to avoid common mistakes.

  • When adjusting a region because the spacing is not a multiple of it, change both the lower and the upper boundaries to spread the change more evenly (#21)

  • Optional arguments to functions are now keyword-only, avoiding the common mistake of passing a spacing in the place of a shape when not using keywords (#20)

Bordado also exposes some sanity checks that other packages can use:

  • Add function check_coordinates to check that all coordinates have same shape and make sure they are arrays (#29)

  • Add function check_region to make sure the region has an even number of arguments and they are in the right order (#12 and #14)

This release contains contributions from:

  • Leonardo Uieda

Version 0.0.1#

Released on: 2025/03/19

doi: https://doi.org/10.5281/zenodo.15051756

This is the first release of Bordado, used to guarantee the package name and setup the development infrastructure. The next release will contain actual code for users.

This release contains contributions from:

  • Leonardo Uieda

Contents