airqo-platform / AirQo-api

This repo contains API definitions for the AirQo platform
MIT License
22 stars 20 forks source link

Enhanced Data Acquisition Speed Through Parallel Computing #3233

Closed wabinyai closed 3 months ago

wabinyai commented 3 months ago

WHAT DOES THIS PR DO? This PR improves upon previous efforts by enhancing the speed of data acquisition through the implementation of parallel computing techniques.

WHAT ISSUES ARE RELATED TO THIS PR?

HOW DO I TEST OUT THIS PR?

WHICH ENDPOINTS SHOULD BE READY FOR TESTING?:

ARE THERE ANY RELATED PRs?

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent updates introduce parallel processing for improved performance in PM2.5 data retrieval within the `BasePM25Model`, `PM25ModelDaily`, and `SatelliteData` classes using `ThreadPoolExecutor`. Additionally, the title in the response dictionary of the `get_pollutants_data` function has been standardized for consistency. These modifications aim to enhance efficiency and clarity in data handling and presentation. ## Changes | File | Change Summary | |-----------------------------------|---------------------------------------------------------------------------------------------------------------| | `src/spatial/models/pull_satellite_model.py` | - Added method `get_pm25_for_multiple_locations` in `BasePM25Model`.
- Modified `get_aod_for_dates` in `PM25ModelDaily` to use concurrency.
- Updates in `SatelliteData` for concurrent fetching and merging pollutant data. | | `src/spatial/views/derived_pm2_5.py` | Changed 'Title' key value in `get_pollutants_data` from 'Daily Sentinel-5P Pollutant Data' to 'Daily_Sentinel-5P_Pollutant_Data'. | ## Sequence Diagram(s) ### Concurrent Data Fetching in PM25ModelDaily ```mermaid sequenceDiagram participant Client participant PM25ModelDaily participant ThreadPoolExecutor participant DataSource Client->>PM25ModelDaily: get_aod_for_dates(longitude, latitude, start_date, end_date) PM25ModelDaily->>ThreadPoolExecutor: submit(fetch_data, params) loop For each date ThreadPoolExecutor->>DataSource: fetch_aod_data(date, lat, lon) DataSource->>ThreadPoolExecutor: return data end ThreadPoolExecutor->>PM25ModelDaily: return merged data PM25ModelDaily->>Client: return AOD data ``` ### Parallel PM2.5 Retrieval in BasePM25Model ```mermaid sequenceDiagram participant Client participant BasePM25Model participant ThreadPoolExecutor participant DataSource Client->>BasePM25Model: get_pm25_for_multiple_locations(locations, start_date, end_date) BasePM25Model->>ThreadPoolExecutor: submit(fetch_pm25, location, start_date, end_date) loop For each location ThreadPoolExecutor->>DataSource: fetch_pm25_data(location, start_date, end_date) DataSource->>ThreadPoolExecutor: return PM2.5 data end ThreadPoolExecutor->>BasePM25Model: return combined PM2.5 data BasePM25Model->>Client: return PM2.5 data ``` ## Poem > In code we trust, for speed we strive, > With threads so bright, our data thrives. > PM2.5 in parallel we gain, > Our efforts yield, efficiency's reign. > Titles now clear, shining through, > Our pollutant quest, precise and true. 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 30.30%. Comparing base (214d559) to head (5ea1b5d). Report is 5 commits behind head on staging.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3233/graphs/tree.svg?width=650&height=150&src=pr&token=HHq3qS3cL6&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform)](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3233?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) ```diff @@ Coverage Diff @@ ## staging #3233 +/- ## ======================================== Coverage 30.30% 30.30% ======================================== Files 184 184 Lines 24487 24487 Branches 3205 3205 ======================================== Hits 7421 7421 Misses 16952 16952 Partials 114 114 ```
github-actions[bot] commented 3 months ago

Spatial changes in this PR available for preview here