feat: adding towncrier #3278

arunavabasucom · 2023-08-20T05:13:26Z

Description

Using towncrier for CHANGELOG.md

Fixes #2885

Type of change

Using towncrier for CHANGELOG.md

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: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
All tests pass: $ python run-tests.py --all (or $ nox -s tests)
The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

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

arunavabasucom · 2023-08-20T05:15:59Z

@tinosulzer @Saransh-cpp pls check do you want this way or their is any approach i have to follow , just done for v23.5 , if it is ok then i goona add all the versions !!

Saransh-cpp

Thanks for working on this, @arunavabasu-03! 🙂

Took a quick look, and will deep dive into towncrier in a few days!

Saransh-cpp · 2023-08-20T19:06:22Z

changelogs/v23.5/bugfix.rst

+=========
+
+- Realign 'count' increment in CasadiSolver.\_integrate() ([#2986](https://github.com/pybamm-team/PyBaMM/pull/2986))
+- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))


Links are handled differently in rst, which is why pre-commit is failing.

Saransh-cpp · 2023-08-20T19:08:56Z

changelogs/v23.5/breakingchanges.rst

+Breaking changes
+=========


Suggested change

Breaking changes

=========

Breaking changes

================

Saransh-cpp · 2023-08-20T19:09:16Z

changelogs/v23.5/bugfix.rst

+=========
+
+- Realign 'count' increment in CasadiSolver.\_integrate() ([#2986](https://github.com/pybamm-team/PyBaMM/pull/2986))
+- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))


rst uses double backticks

Suggested change

- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

- Fix ``pybamm_install_odes`` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

Saransh-cpp · 2023-08-20T19:09:23Z

changelogs/v23.5/bugfix.rst

+- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))
+- Fixed a bug where all data included in a BPX was incorrectly assumed to be given as a function of time.([#2957](https://github.com/pybamm-team/PyBaMM/pull/2957))
+- Remove brew install for Mac from the recommended developer installation options for SUNDIALS ([#2925](https://github.com/pybamm-team/PyBaMM/pull/2925))
+- Fix `bpx.py` to correctly generate parameters for "lumped" thermal model ([#2860](https://github.com/pybamm-team/PyBaMM/issues/2860))


Suggested change

- Fix `bpx.py` to correctly generate parameters for "lumped" thermal model ([#2860](https://github.com/pybamm-team/PyBaMM/issues/2860))

- Fix ``bpx.py`` to correctly generate parameters for "lumped" thermal model ([#2860](https://github.com/pybamm-team/PyBaMM/issues/2860))

Saransh-cpp · 2023-08-20T19:09:32Z

changelogs/v23.5/feature.rst

+=========
+
+- Enable multithreading in IDAKLU solver ([#2947](https://github.com/pybamm-team/PyBaMM/pull/2947))
+- If a solution contains cycles and steps, the cycle number and step number are now saved when `solution.save_data()` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))


Suggested change

- If a solution contains cycles and steps, the cycle number and step number are now saved when `solution.save_data()` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))

- If a solution contains cycles and steps, the cycle number and step number are now saved when ``solution.save_data()`` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))

Saransh-cpp · 2023-08-20T19:09:39Z

changelogs/v23.5/feature.rst

+
+- Enable multithreading in IDAKLU solver ([#2947](https://github.com/pybamm-team/PyBaMM/pull/2947))
+- If a solution contains cycles and steps, the cycle number and step number are now saved when `solution.save_data()` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))
+- Experiments can now be given a `start_time` to define when each step should be triggered ([#2616](https://github.com/pybamm-team/PyBaMM/pull/2616))


Suggested change

- Experiments can now be given a `start_time` to define when each step should be triggered ([#2616](https://github.com/pybamm-team/PyBaMM/pull/2616))

- Experiments can now be given a ``start_time`` to define when each step should be triggered ([#2616](https://github.com/pybamm-team/PyBaMM/pull/2616))

Saransh-cpp · 2023-08-20T19:09:50Z

changelogs/v23.5/optimizations.rst

+Optimizations
+=========


Suggested change

Optimizations

=========

Optimizations

=============

Saransh-cpp · 2023-08-20T19:10:18Z

changelogs/v23.5/optimizations.rst

+- Test `JaxSolver`'s compatibility with Python `3.8`, `3.9`, `3.10`, and `3.11` ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))
+- Update Jax (0.4.8) and JaxLib (0.4.7) compatibility ([#2927](https://github.com/pybamm-team/PyBaMM/pull/2927))
+- Migrate from `tox=3.28` to `nox` ([#3005](https://github.com/pybamm-team/PyBaMM/pull/3005))
+- Removed `importlib_metadata` as a required dependency for user installations ([#3050](https://github.com/pybamm-team/PyBaMM/pull/3050))


Suggested change

- Test `JaxSolver`'s compatibility with Python `3.8`, `3.9`, `3.10`, and `3.11` ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

- Update Jax (0.4.8) and JaxLib (0.4.7) compatibility ([#2927](https://github.com/pybamm-team/PyBaMM/pull/2927))

- Migrate from `tox=3.28` to `nox` ([#3005](https://github.com/pybamm-team/PyBaMM/pull/3005))

- Removed `importlib_metadata` as a required dependency for user installations ([#3050](https://github.com/pybamm-team/PyBaMM/pull/3050))

- Test ``JaxSolver``'s compatibility with Python ``3.8``, ``3.9``, ``3.10``, and ``3.11`` ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

- Update Jax (0.4.8) and JaxLib (0.4.7) compatibility ([#2927](https://github.com/pybamm-team/PyBaMM/pull/2927))

- Migrate from ``tox=3.28`` to ``nox`` ([#3005](https://github.com/pybamm-team/PyBaMM/pull/3005))

- Removed ``importlib_metadata`` as a required dependency for user installations ([#3050](https://github.com/pybamm-team/PyBaMM/pull/3050))

Saransh-cpp · 2023-08-20T19:10:54Z

changelogs/v23.5/bugfix.rst

+=========
+
+- Realign 'count' increment in CasadiSolver.\_integrate() ([#2986](https://github.com/pybamm-team/PyBaMM/pull/2986))
+- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))


Suggested change

- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

- Fix ``pybamm_install_odes`` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

agriyakhetarpal · 2023-08-20T19:32:13Z

I think we can convert the entire CHANGELOG.md file using executablebooks/rst-to-myst, or we could just keep it in Markdown like it is already because I feel the syntax is more intuitive

agriyakhetarpal · 2023-10-08T16:36:09Z

@arunavabasu-03, was this in error or would you not be working on this feature anymore?

arunavabasucom and others added 2 commits August 20, 2023 05:08

feat: adding towncrier

a0ec8c5

style: pre-commit fixes

5149b86

agriyakhetarpal mentioned this pull request Aug 20, 2023

New release system #3249

Merged

8 tasks

Saransh-cpp requested changes Aug 20, 2023

View reviewed changes

arunavabasucom closed this by deleting the head repository Oct 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding towncrier #3278

feat: adding towncrier #3278

arunavabasucom commented Aug 20, 2023 •

edited

Loading

arunavabasucom commented Aug 20, 2023 •

edited

Loading

Saransh-cpp left a comment

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

Saransh-cpp Aug 20, 2023

agriyakhetarpal commented Aug 20, 2023

agriyakhetarpal commented Oct 8, 2023

	- Fix `pybamm_install_odes` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))
	- Fix ``pybamm_install_odes`` and update the required SUNDIALS version ([#2958](https://github.com/pybamm-team/PyBaMM/pull/2958))

	- Fix `bpx.py` to correctly generate parameters for "lumped" thermal model ([#2860](https://github.com/pybamm-team/PyBaMM/issues/2860))
	- Fix ``bpx.py`` to correctly generate parameters for "lumped" thermal model ([#2860](https://github.com/pybamm-team/PyBaMM/issues/2860))

	- If a solution contains cycles and steps, the cycle number and step number are now saved when `solution.save_data()` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))
	- If a solution contains cycles and steps, the cycle number and step number are now saved when ``solution.save_data()`` is called ([#2931](https://github.com/pybamm-team/PyBaMM/pull/2931))

	- Experiments can now be given a `start_time` to define when each step should be triggered ([#2616](https://github.com/pybamm-team/PyBaMM/pull/2616))
	- Experiments can now be given a ``start_time`` to define when each step should be triggered ([#2616](https://github.com/pybamm-team/PyBaMM/pull/2616))

feat: adding towncrier #3278

feat: adding towncrier #3278

Conversation

arunavabasucom commented Aug 20, 2023 • edited Loading

Description

Type of change

Key checklist:

Further checks:

arunavabasucom commented Aug 20, 2023 • edited Loading

Saransh-cpp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agriyakhetarpal commented Aug 20, 2023

agriyakhetarpal commented Oct 8, 2023

arunavabasucom commented Aug 20, 2023 •

edited

Loading

arunavabasucom commented Aug 20, 2023 •

edited

Loading