Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements, Numpy support improvement and batch renaming #189

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

jeandet
Copy link
Member

@jeandet jeandet commented Jan 18, 2025

This pull request includes various changes to improve the codebase, update documentation, and enhance compatibility with external libraries. The most important changes include updating the wheel build process in the Makefile, renaming and restructuring documentation files, and enhancing compatibility with NumPy and SciPy.

Build Process Improvements:

  • Makefile: Updated the build process to use python -m build --sdist --wheel instead of python setup.py commands for building source and wheel packages. This modernizes the build process.

Documentation Updates:

  • docs/user/webservices.rst renamed to docs/user/data_providers.rst: Updated references to data providers throughout the documentation to reflect the new file name and structure. [1] [2]
  • docs/index.rst: Enhanced the introduction and features section, added new sections for NumPy and SciPy compatibility, and included images and examples for better clarity. [1] [2] [3] [4]

Compatibility Enhancements:

  • docs/user/numpy.rst: Added a new section detailing the compatibility of Speasy with NumPy, including examples of arithmetic operations, NumPy functions, and indexing methods.
  • docs/user/scipy.rst: Added a new section explaining how Speasy integrates with SciPy for interpolation, filtering, and resampling, along with detailed examples.

Codebase Improvements:

  • speasy/core/data_containers.py: Improved handling of datetime objects by ensuring they are converted to UTC before processing, and added a copy method to DataContainer for deep copying. [1] [2] [3]
  • speasy/core/http.py: Refactored URL rewrite rules application by using the ApplyRewriteRules decorator to streamline the code and reduce redundancy. [1] [2] [3]

These changes collectively aim to improve the usability, maintainability, and functionality of the codebase and its documentation.

@jeandet jeandet added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 18, 2025
@jeandet jeandet added this to the 1.5 milestone Jan 18, 2025
@jeandet jeandet force-pushed the remove_direct_ws_usage_from_doc branch 3 times, most recently from f278093 to b33fd7b Compare January 18, 2025 16:06
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
4 Security Hotspots

See analysis details on SonarQube Cloud

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@jeandet jeandet force-pushed the remove_direct_ws_usage_from_doc branch from 5edd4f5 to 491826f Compare February 21, 2025 16:33
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@jeandet jeandet changed the title Documentation improvements and few minor fixes Documentation improvements, Numpy support improvement and batch renaming Feb 21, 2025
@jeandet jeandet requested a review from brenard-irap February 21, 2025 17:14
@jeandet jeandet linked an issue Feb 21, 2025 that may be closed by this pull request
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: display variable info
1 participant