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

Create AbstractCompute class #752

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

shorvath-noaa
Copy link
Contributor

Creating an abstract class to replace the functionality of compute.py. The four current compute methods (serial, by_network, by_subnetwork_jit, and by_subnetwork_jit_clustered) share a lot of common methods. This PR merges those into an abstract class that builds from the simplest compute method (serial) to the most complex (by_subnetwork_jit_clustered). This eliminates the excess, repetitive code and groups functionality in logical places.

Additions

AbstractCompute.py

  • Abstract classes for compute methods

Removals

Changes

Testing

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

@shorvath-noaa shorvath-noaa changed the title Create AbstractCompute class. This is meant to eventually replace compute.py Create AbstractCompute class Mar 18, 2024
@shorvath-noaa shorvath-noaa reopened this Mar 19, 2024
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.

2 participants