Skip to content

Conversation

@MitchellAcoustics
Copy link
Owner

This pull request makes several changes across the codebase, mainly focused on documentation cleanup, test configuration improvements, and packaging adjustments. The most significant updates include removing or commenting out sections of the documentation, refining the optional dependency handling in test configuration, and updating the package manifest to better control included and excluded files.

Documentation cleanup and restructuring:

  • Removed multiple detailed reference and module documentation files from the docs/reference directory, streamlining the documentation and possibly preparing for a new documentation approach. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Test configuration and dependency handling:

  • Enhanced the conftest.py logic to support new dependency groups (r, satp) and improved how optional dependencies are checked and mapped to test directories. This allows for more precise control over which tests are run based on available dependencies. [1] [2] [3] [4] [5]
  • Updated the test selection example in CONTRIBUTING.md to use bash syntax for clarity.

Packaging and distribution:

  • Updated MANIFEST.in to more explicitly include and exclude files and directories, ensuring that only the necessary files are packaged and distributed.

Continuous integration workflow adjustments:

  • Commented out steps in GitHub Actions workflows (tag-release.yml, test-tag-release.yml) that install the soundscapy[all] extra, likely due to instability or issues with those installs. Also removed a version check step to simplify the release process. [1] [2] [3]

Tutorial and notebook minor updates:

  • Made small adjustments to the tutorial notebook to remove unused imports and update execution timestamps, keeping the example up to date and cleaner. [1] [2] [3] [4] [5] [6] [7]

Prepare for Soundscapy v0.8.0: ISOPlot API and Soundscape Perception Indices
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
- Add CircE package availability checking and version validation
- Integrate CircE package into R session initialization and management
- Update package installation to handle GitHub-hosted CircE package
- Modify session getter to return CircE package instance
- Update tests to verify CircE package checking functionality
- Implement BFGS algorithm wrapper for circe package
- Add model type enumeration and constraints handling
- Update rpy2 dependency to include [all] extras
- Export EQUAL_ANGLES from survey_utils module
Add CircEResult dataclass and bfgs wrapper function to public API, with improved type validation and result extraction from R circe package.
…d update imports

Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
@MitchellAcoustics MitchellAcoustics self-assigned this Oct 2, 2025
@MitchellAcoustics MitchellAcoustics added enhancement New feature or request internals Improvements to the internals like dependencies, ci, etc. labels Oct 2, 2025
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
Signed-off-by: Andrew Mitchell <a.j.mitchell@ucl.ac.uk>
@MitchellAcoustics MitchellAcoustics merged commit c9948f2 into dev Oct 2, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request internals Improvements to the internals like dependencies, ci, etc.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant