refactor!: spice managers

vishwa2710 commented 1 week ago

This MR refactors the spice manager to follow the same patterns as the other managers.

Summary by CodeRabbit

Release Notes

New Features
- Enhanced documentation in the README, including new badges for quick access to build status and versioning.
- Expanded "Getting Started" section with Docker usage details for iPython and JupyterLab.
- Clarified installation instructions for C++ and Python binary packages.
- Introduced "Automatic" and "Manual" modes for data loading in the "Data Management" section.
- Updated setup recommendations to use Docker for development.
Bug Fixes
- Removed outdated methods related to local repository management in the Manager class.
Refactor
- Simplified mode management by centralizing it in the Manager class, removing direct mode handling from the Engine class.
- Streamlined test structure by converting standalone tests into a test fixture class for better organization and resource management.

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request involve significant updates to the documentation and code structure of the Open Space Toolkit for Physics. The README.md has been enhanced with new sections and clarifications regarding installation, data management, and usage of Docker. In the code, the Engine and Manager classes have been refactored to simplify mode management by centralizing it within the Manager. This includes the removal of mode-related methods and variables from the Engine, alongside modifications to the test cases to reflect these structural changes.

Changes

File	Change Summary
README.md	Enhanced documentation with badges, expanded "Getting Started", clarified "Installation", elaborated "Data Management", updated "Setup", and listed dependencies.
include/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Engine.hpp	Removed `Mode` enum and related methods; updated constructor to default constructor; added deleted move constructor and assignment operator.
include/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Manager.hpp	Updated class to inherit from `BaseManager`; deleted copy constructor/assignment; removed local repository management methods.
src/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Engine.cpp	Removed mode-related methods; updated constructor; modified kernel loading logic to rely on `Manager`.
src/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Manager.cpp	Altered constructor to initialize from `BaseManager`; removed local repository management methods; refactored initialization logic.
test/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE.test.cpp	Converted standalone tests to a fixture class; updated test methods to use new member variables for `Engine` and `Manager`.
test/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Engine.test.cpp	Added dependency on `Manager`; updated tests to reflect mode management changes; removed `GetMode` test.
test/OpenSpaceToolkit/Physics/Environment/Ephemeris/SPICE/Manager.test.cpp	Added member variable for mode; updated `SetUp` and `TearDown` methods; removed local repository tests.

Possibly related PRs

279: The changes in Engine.cpp regarding the management of kernel loading and mode handling are related to the modifications in the README.md that elaborate on the data management and setup processes, particularly the shift towards using the Manager class for mode management.
284: The introduction of the setup() method in the Manager class enhances the initialization process, which aligns with the updates in the README.md that clarify the setup and installation instructions for users.

Suggested reviewers

apaletta3

🐰 In the garden, changes bloom,
With badges bright, dispelling gloom.
Modes now managed, neat and clear,
Documentation brings us cheer!
Docker's here, let's set the stage,
For physics fun at every age! 🌼

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 82.37%. Comparing base (390d052) to head (3876c88). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #291 +/- ## ========================================== - Coverage 82.39% 82.37% -0.03% ========================================== Files 102 102 Lines 8027 7989 -38 ========================================== - Hits 6614 6581 -33 + Misses 1413 1408 -5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

open-space-collective / open-space-toolkit-physics