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

Issue 964 show params #993

Merged
merged 2 commits into from
May 14, 2020
Merged

Issue 964 show params #993

merged 2 commits into from
May 14, 2020

Conversation

rtimms
Copy link
Contributor

@rtimms rtimms commented May 13, 2020

Description

Adds an attribute parameters to the model that lists all of the parameters (similar to the attribute input_parameters). Also add parameters attribute to geometry. Now users can see which parameters a model requires by doing model.parameters (before it is processed). Note: this is different to model.param which is the module of parameters that model uses.

Also removes parameters related to tabs that aren't correct for a given set (they were inadvertently copied from the Marquis2019 set)
Fixes #964

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ flake8
  • All tests pass: $ python run-tests.py --unit
  • The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

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

Looks great, cheers.
If we add more of these methods to query the model we should think about making it a single function to reduce repeated code, but it's fine for now

@codecov
Copy link

codecov bot commented May 13, 2020

Codecov Report

Merging #993 into develop will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #993   +/-   ##
========================================
  Coverage    97.55%   97.56%           
========================================
  Files          233      233           
  Lines        12083    12106   +23     
========================================
+ Hits         11788    11811   +23     
  Misses         295      295           
Impacted Files Coverage Δ
pybamm/geometry/geometry.py 98.67% <100.00%> (+0.13%) ⬆️
pybamm/models/base_model.py 98.81% <100.00%> (+0.03%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 747be3a...9e289c4. Read the comment docs.

@rtimms rtimms merged commit 729e5f8 into develop May 14, 2020
@rtimms rtimms deleted the issue-964-show-params branch May 14, 2020 09:19
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.

electrode tab coordinate inputs
2 participants