Experiment Drive Cycle with Events

[alibh95]

Description

Added the functionality of simulating drive cycles in Experiment class along with the 'for' event.
If the time specified in the 'for' event is less than the drive cycle time, then the drive cycle is stopped at the time specified in the 'for' event.
Else If the time specified in the 'for' event is greater than the drive cycle time, the drive cycle first extended for one week and then stopped at the time specified in the 'for' event.

Fixes # (issue)

#1193
#1293 (Can extend single and/or multiple drive cycles for long time durations)

Note:

I am new to GitHub. I was not able to manage my previous pull request (#1279) effectively. Therefore, I am opening this new pull request. I am sorry for any inconvenience I caused.

Warning

In this PR, Only the Experiment class is modified to support drive cycle functionality. This functionality is not actually implemented in Simulation yet.

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]

Codecov Report

Merging #1304 (dab2451) into develop (daf7fa7) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop    #1304      +/-   ##
===========================================
- Coverage    98.28%   98.27%   -0.01%     
===========================================
  Files          280      280              
  Lines        16165    16198      +33     
===========================================
+ Hits         15887    15918      +31     
- Misses         278      280       +2     

Impacted Files	Coverage Δ
pybamm/experiments/experiment.py	97.40% <100.00%> (-0.95%)	⬇️

---

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 daf7fa7...dab2451. Read the comment docs.

[brosaplanella]

Hi @alibh95! The errors in the MacOs tests should now be fixed if you merge in the develop branch. Let me know if the PR is ready to be reviewed.

[brosaplanella]

Hi @alibh95! What's the state of this PR?

[alibh95]

Hi @brosaplanella . This pull request successfully simulates drive cycles using experiment class. The implementation of for event have been completed. The drive cycle is clipped or extended depending upon the time period provided in the for event.
Unfortunately, I am unable to spare much time for the successful implementation of until event because I am heavily occupied in completing my thesis.
The issue I am facing in the implementation of until event is that whenever until event is triggered, the solver continues to solve the drive cycle instead of stoping.
Any tips/suggestions would be helpful for me to complete this PR.

[valentinsulzer]

Hi @alibh95 , thanks for taking this on. We're going to implement this slightly differently in the simulation now that #1408 allows a better approach. Still, what you have added to the Experiment class is useful - could you change the PR to include only those changes (not the changes to the Simulation class)? Also add a warning that the drive cycle functionality is not actually implemented in Simulation yet.

[valentinsulzer]

Thanks @alibh95 , looks good now. We're about to do a release, I will wait until that is done before merging as otherwise it might be confusing why you can specify a drive cycle in the experiment but not solve it

[valentinsulzer]

@all-contributors add @alibh95 for code, tests

[allcontributors]

@tinosulzer

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