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

Add BaseParameters and SymPy #1495

Merged
merged 5 commits into from
May 27, 2021
Merged

Conversation

priyanshuone6
Copy link
Member

Description

  • Add Base Parameters class and tests
  • Set Base Parameters as the parent class of all parameters
  • Add SymPy in dependencies

(GSoC21: Print Equations)

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

@codecov
Copy link

codecov bot commented May 26, 2021

Codecov Report

Merging #1495 (e82ca77) into develop (fe6960c) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1495   +/-   ##
========================================
  Coverage    98.34%   98.34%           
========================================
  Files          295      296    +1     
  Lines        17093    17104   +11     
========================================
+ Hits         16810    16821   +11     
  Misses         283      283           
Impacted Files Coverage Δ
pybamm/parameters/base_parameters.py 100.00% <100.00%> (ø)
pybamm/parameters/electrical_parameters.py 100.00% <100.00%> (ø)
pybamm/parameters/geometric_parameters.py 100.00% <100.00%> (ø)
pybamm/parameters/lead_acid_parameters.py 100.00% <100.00%> (ø)
pybamm/parameters/lithium_ion_parameters.py 100.00% <100.00%> (ø)
pybamm/parameters/parameter_values.py 99.43% <100.00%> (ø)
pybamm/parameters/thermal_parameters.py 100.00% <100.00%> (ø)

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 fe6960c...e82ca77. Read the comment docs.

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.

BaseParameters class looks good but test needs changing. In general it is best for unit tests to call the least number of methods possible (i.e. not require on other things not changing).
Also can you add the "GSOC21: print equations" label on the rhs? Or do you not have permissions to do that?

setup.py Outdated Show resolved Hide resolved
requirements.txt Outdated Show resolved Hide resolved
tests/unit/test_parameters/test_base_parameters.py Outdated Show resolved Hide resolved
@priyanshuone6
Copy link
Member Author

@tinosulzer I do not have the permission to add labels

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.

Thanks @priyanshuone6 , I'll add the label for now and look into how to get you access

@valentinsulzer
Copy link
Member

Also please update the CHANGELOG.md with your changes

@priyanshuone6
Copy link
Member Author

Thanks @tinosulzer

@valentinsulzer valentinsulzer merged commit bc6bf36 into pybamm-team:develop May 27, 2021
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