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

Release notes 24.5 #113

Merged
merged 18 commits into from
Jul 26, 2024
Merged

Release notes 24.5 #113

merged 18 commits into from
Jul 26, 2024

Conversation

brosaplanella
Copy link
Member

@brosaplanella brosaplanella commented Feb 5, 2024

Important

Do not merge until final release for 24.5 has been published!

Given that I forgot last time, starting the document for next release now so we can add features as we go. Ideally we want the authors of the relevant PRs to add a paragraph here, so we just need to make small edits when the release occurs.

Copy link

netlify bot commented Feb 5, 2024

Deploy Preview for pybamm-developer-preview ready!

Name Link
🔨 Latest commit ac15350
🔍 Latest deploy log https://app.netlify.com/sites/pybamm-developer-preview/deploys/66a33b710868c80008fe44e0
😎 Deploy Preview https://deploy-preview-113--pybamm-developer-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 87
Accessibility: 100
Best Practices: 100
SEO: 92
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

The links to deleted notebooks in `learn.md` now have been removed.
Related to pybamm-team/PyBaMM#3750
@brosaplanella
Copy link
Member Author

brosaplanella commented Jun 5, 2024

List of features we should include (IMO):

  • Tortuosity factor submodels
  • Basic models compatible with experiments
  • Plot thermal components
  • Plating with composite electrodes
  • Custom experiment steps
  • Hysteresis submodel
  • Print parameter info
  • macOS arm64 M-series support
  • BPX support

Please let me know if you think there are others that should be included. I will try to either write them or chase the developers who implemented the features.

@brosaplanella
Copy link
Member Author

I implemented all of the above except the plating in composite electrodes as I couldn't find a working example to copy from (and I needed to define additional parameters and I am quite pressed for time this week). Happy to not include or, if someone can suggest a MWE happy to include it.

@DrSOKane
Copy link

Hi Ferran. The reason there isn't a worked example for the composite plating is that the only paper I have found that implements it has some parameters missing. I'm strongly in favour of having it available to anyone using the developer install, as I know a few people who want to use it.

@brosaplanella
Copy link
Member Author

Cool! Then happy to include it with a disclaimer about the missing parameters. What options do I need to pass to set the model with composite plating?

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 very much for picking this up @brosaplanella , this looks great. Could we add an italic subtitle for the main contributor(s) to each feature and their affiliation? This may also encourage people to contribute more and write up about their contributions

@brosaplanella
Copy link
Member Author

I have now added the contributors. To be consistent, I pulled all the data (names & institutions) from their Github users when available, and defaulted to the username when not available (even for people we know). Most PRs were from a single contributors, but for the Hackathon one I listed everyone from the PR.

I am away from Friday, so might be a bit slow merging that. Once the release happens, feel free to update the date and go ahead merging it.

@agriyakhetarpal
Copy link
Member

Thanks, @brosaplanella! I guess we'll make the release on Monday, if someone gets to this before I do, please do so and merge. The style check (codespell) is failing because of a name, while it seems to have recognised others' names. Maybe we should find a way to tame it sometime.

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

The failing check can be fixed by adding "Meda" to the list of words to ignore -

@agriyakhetarpal
Copy link
Member

Addressed in 99ea446.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

I'm merging this with the update to the date, as seen in the review comment below so that the release notes are highlighted first. The theme currently doesn't support displaying two news items on the home page simultaneously, so we will have to remove the advertisement blog post from the headline for now.

content/news/2024/05/31/pybamm-24.5.md Outdated Show resolved Hide resolved
@agriyakhetarpal agriyakhetarpal merged commit ce45a66 into main Jul 26, 2024
0 of 2 checks passed
@agriyakhetarpal agriyakhetarpal deleted the release-notes-24.5 branch July 26, 2024 06:00
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.

5 participants