Skip to content

Mirror r circumplex#5

Merged
MitchellAcoustics merged 97 commits intodevfrom
mirror-R-circumplex
Nov 9, 2025
Merged

Mirror r circumplex#5
MitchellAcoustics merged 97 commits intodevfrom
mirror-R-circumplex

Conversation

@MitchellAcoustics
Copy link
Owner

Complete rewrite to implement and mirror all functionality from R Circumplex.

Automation and CI/CD:

  • Added GitHub Actions workflows for documentation (docs.yml), linting (linting.yml), and tests (tests.yml), enabling automated builds, checks, and deployments for every push and pull request. [1] [2] [3]

Documentation Improvements:

  • Added API reference pages and reorganized documentation structure, including new Markdown files for various modules and an improved README.md with badges and project layout. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]
  • Updated .readthedocs.yaml to include additional documentation plugins and dependencies for richer docs.

Code Quality and Linting:

  • Added and configured .pre-commit-config.yaml to enforce code style, linting, and formatting standards, including hooks for Python, Markdown, TOML, and JSON files.
  • Added .markdownlint.yaml to disable specific markdown linting rules and .prettierignore to exclude Markdown files from Prettier formatting. [1] [2]

Project Metadata and Configuration:

  • Updated CITATION.cff with new version, consistent formatting, and updated URLs.
  • Removed .python-version to rely on workflow-managed Python versions.

Cleanup and Removals:

  • Removed placeholder content from docs/about.md to prepare for new documentation.

MitchellAcoustics and others added 30 commits July 5, 2024 11:01
The confidence intervals and plotting don't work correctly when the bounds are forced to (0, 2pi). Therefore we allow negative angles for the CIs only.
- Standardize naming with ssm_analyze instead of ssm_analyse
- Add comprehensive docstrings using NumPy style
- Add examples to key functions
- Fix circular imports between modules
- Add centralized parameter validation
- Improve typing with more specific return annotations
- Add consistent plot methods to SSMResults
Andrew Mitchell added 28 commits November 9, 2025 17:52
Removes trailing whitespace from license file and normalizes spacing in configuration files to improve consistency.

Adds GitHub issue forms JSON schema to enable validation and autocomplete for issue template definitions.
Makes scales parameter optional in normalization functions, defaulting to all instrument scales when not specified.

Adds new angle utility functions for octant positioning and cosine modeling.

Reorganizes imports to improve module structure and accessibility.
@MitchellAcoustics MitchellAcoustics merged commit 04e7aed into dev Nov 9, 2025
6 checks passed
@MitchellAcoustics MitchellAcoustics deleted the mirror-R-circumplex branch November 9, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant