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

Restructure for improved modularity #60

Closed
wants to merge 12 commits into from

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Oct 16, 2023

Pull request to address issue #54

@NicolaCourtier NicolaCourtier self-assigned this Oct 16, 2023
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

Merging #60 (b0ee269) into develop (b66b807) will increase coverage by 2.01%.
Report is 3 commits behind head on develop.
The diff coverage is 82.83%.

@@             Coverage Diff             @@
##           develop      #60      +/-   ##
===========================================
+ Coverage    79.15%   81.16%   +2.01%     
===========================================
  Files           15       18       +3     
  Lines          379      531     +152     
===========================================
+ Hits           300      431     +131     
- Misses          79      100      +21     
Files Coverage Δ
pybop/__init__.py 100.00% <100.00%> (ø)
pybop/models/lithium_ion/__init__.py 100.00% <ø> (ø)
pybop/models/lithium_ion/base_echem.py 100.00% <100.00%> (ø)
pybop/optimisers/base_optimiser.py 91.66% <100.00%> (ø)
pybop/parameters/priors.py 55.31% <ø> (ø)
pybop/datasets/base_dataset.py 69.23% <50.00%> (ø)
pybop/parameters/base_parameter.py 92.30% <80.00%> (ø)
pybop/parameters/base_parameter_set.py 40.00% <0.00%> (ø)
tests/unit/test_parameterisation.py 98.14% <97.56%> (-1.86%) ⬇️
pybop/optimisation.py 94.44% <94.44%> (ø)
... and 6 more

... and 1 file with indirect coverage changes

@NicolaCourtier NicolaCourtier linked an issue Oct 19, 2023 that may be closed by this pull request
.gitattributes Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this

@@ -301,3 +301,6 @@ $RECYCLE.BIN/
*.lnk

# End of https://www.toptal.com/developers/gitignore/api/python,macos,windows,linux,c

# Visual Studio Code settings
.vscode/*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep

@@ -1,13 +1,13 @@
#
# Root of the pybop module.
# Root of the PyBOP module.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to sort out a standard for this, real low priority though.

# Provides access to all shared functionality (models, solvers, etc.).
#
# This file is adapted from Pints
# (see https://github.com/pints-team/pints)
#

import sys
import os
from os import path
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe don't need to change, depends on whether we need any functionality from os in the future.

from .plotting.quick_plot import QuickPlot

#
# Remove any imported modules, so we don't expose them as part of PyBOP
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for the above.

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.

Add run-tests.py Prepare for the initial release Code restructure for improved modularity
2 participants