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

Refactor problems #280

Merged

Conversation

brosaplanella
Copy link
Contributor

@brosaplanella brosaplanella commented Apr 8, 2024

Description

Refactor the various problem classes into separate folders.

Issue reference

Fixes #279

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

@brosaplanella
Copy link
Contributor Author

As this is refactoring, let me know if it should have a line in the CHANGELOG or not (and under which category).

@BradyPlanden
Copy link
Member

Thanks for the addition @brosaplanella!

Unforunately, this is currently blocked as the codecov is silently failing. A fix for this is in #275, if you want to add that fix to this branch I'm happy to review. Otherwise I'll review once we've merged #275 and this branch merges develop.

Copy link

codecov bot commented Apr 13, 2024

Codecov Report

Attention: Patch coverage is 95.55556% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 95.49%. Comparing base (433d10c) to head (f58c73f).
Report is 1 commits behind head on develop.

Files Patch % Lines
pybop/problems/design_problem.py 88.46% 3 Missing ⚠️
pybop/problems/base_problem.py 96.92% 2 Missing ⚠️
pybop/problems/fitting_problem.py 97.43% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #280      +/-   ##
===========================================
+ Coverage    95.47%   95.49%   +0.01%     
===========================================
  Files           36       38       +2     
  Lines         2034     2040       +6     
===========================================
+ Hits          1942     1948       +6     
  Misses          92       92              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BradyPlanden
Copy link
Member

LGTM, thanks for the addition @brosaplanella!

@BradyPlanden BradyPlanden merged commit 36b1b11 into pybop-team:develop Apr 14, 2024
28 checks passed
@BradyPlanden
Copy link
Member

@all-contributors add @brosaplanella to code

Copy link
Contributor

@BradyPlanden

I've put up a pull request to add @brosaplanella! 🎉

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.

Refactor problems into different files
2 participants