Merge pull request #2342 from pybamm-team/issue-2334-reformat-parameters

Issue 2334 reformat parameters
pybamm-team · Oct 11, 2022 · 924ee9e · 924ee9e
2 parents 453abe6 + c3b0676
commit 924ee9e
Show file tree

Hide file tree

Showing 418 changed files with 10,579 additions and 11,793 deletions.
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -1,3 +1,2 @@
 ignore:
-  - pybamm/parameters_cli.py
   - pybamm/install_odes.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,11 @@
 ## Optimizations
 
 - Added more rules for simplifying expressions ([#2211](https://github.com/pybamm-team/PyBaMM/pull/2211))
-- Sped up calculations of Electrode SOH variables for summary variables ([#2210](https://github.com/pybamm-team/PyBaMM/pull/2210))
+
+## Breaking change
+
+- Removed parameter cli tools (add/edit/remove parameters). Parameter sets can now more easily be added via python scripts. ([#2342](https://github.com/pybamm-team/PyBaMM/pull/2342))
+- Parameter sets should now be provided as single python files containing all parameters and functions. Parameters provided as "data" (e.g. OCP vs SOC) can still be csv files, but must be either in the same folder as the parameter file or in a subfolder called "data/". See for example [Ai2020](https://github.com/pybamm-team/PyBaMM/tree/develop/pybamm/input/parameters/lithium_ion/Ai2020.py) ([#2342](https://github.com/pybamm-team/PyBaMM/pull/2342))
 
 # [v22.9](https://github.com/pybamm-team/PyBaMM/tree/v22.9) - 2022-09-30
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -83,7 +83,6 @@ API documentation
    source/util
    source/callbacks
    source/citations
-   source/parameters_cli
    source/batch_study
 
 Examples

diff --git a/docs/source/parameters_cli.rst b/docs/source/parameters_cli.rst