Skip to content

Commit a54b9a5

Browse files
authored
Replace CChem link with attribution to John Newman (#4788)
* Replace citation * Replace bitbucket link and cleanup
1 parent b2fed61 commit a54b9a5

File tree

6 files changed

+22
-33
lines changed

6 files changed

+22
-33
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -422,18 +422,13 @@ wherever code is called that uses that citation (for example, in functions or in
422422

423423
### Installation
424424

425-
Installation of PyBaMM and its dependencies is handled via [pip](https://pip.pypa.io/en/stable/) and [setuptools](http://setuptools.readthedocs.io/). It uses `CMake` to compile C++ extensions using [`pybind11`](https://pybind11.readthedocs.io/en/stable/) and [`casadi`](https://web.casadi.org/). The installation process is described in detail in the [source installation](https://docs.pybamm.org/en/latest/source/user_guide/installation/install-from-source.html) page and is configured through the `CMakeLists.txt` file.
425+
Installation of PyBaMM and its dependencies is handled via [pip](https://pip.pypa.io/en/stable/)
426426

427427
Configuration files:
428-
429428
```
430-
setup.py
431429
pyproject.toml
432-
MANIFEST.in
433430
```
434431

435-
Note: `MANIFEST.in` is used to include and exclude non-Python files and auxiliary package data for PyBaMM when distributing it. If a file is not included in `MANIFEST.in`, it will not be included in the source distribution (SDist) and subsequently not be included in the binary distribution (wheel).
436-
437432
### Continuous Integration using GitHub Actions
438433

439434
Each change pushed to the PyBaMM GitHub repository will trigger the test and benchmark suites to be run, using [GitHub Actions](https://github.com/features/actions).

noxfile.py

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ def run_integration(session):
6464
@nox.session(name="doctests")
6565
def run_doctests(session):
6666
"""Run the doctests and generate the output(s) in the docs/build/ directory."""
67-
# TODO: Temporary fix for Python 3.12 CI.
68-
# See: https://bitbucket.org/pybtex-devs/pybtex/issues/169/
67+
# Fix for Python 3.12 CI. This can be removed after pybtex is replaced.
6968
session.install("setuptools", silent=False)
7069
session.install("-e", ".[all,dev,docs]", silent=False)
7170
session.run(
@@ -102,9 +101,7 @@ def run_examples(session):
102101
def run_scripts(session):
103102
"""Run the scripts tests for Python scripts."""
104103
set_environment_variables(PYBAMM_ENV, session=session)
105-
# Temporary fix for Python 3.12 CI. TODO: remove after
106-
# https://bitbucket.org/pybtex-devs/pybtex/issues/169/replace-pkg_resources-with
107-
# is fixed
104+
# Fix for Python 3.12 CI. This can be removed after pybtex is replaced.
108105
session.install("setuptools", silent=False)
109106
session.install("-e", ".[all,dev,jax]", silent=False)
110107
session.run("python", "-m", "pytest", "-m", "scripts")
@@ -119,9 +116,7 @@ def set_dev(session):
119116
python = os.fsdecode(VENV_DIR.joinpath("bin/python"))
120117
components = ["all", "dev", "jax"]
121118
args = []
122-
# Temporary fix for Python 3.12 CI. TODO: remove after
123-
# https://bitbucket.org/pybtex-devs/pybtex/issues/169/replace-pkg_resources-with
124-
# is fixed
119+
# Fix for Python 3.12 CI. This can be removed after pybtex is replaced.
125120
session.run(python, "-m", "pip", "install", "setuptools", external=True)
126121
session.run(
127122
python,
@@ -153,8 +148,7 @@ def run_tests(session):
153148
def build_docs(session):
154149
"""Build the documentation and load it in a browser tab, rebuilding on changes."""
155150
envbindir = session.bin
156-
# TODO: Temporary fix for Python 3.12 CI.
157-
# See: https://bitbucket.org/pybtex-devs/pybtex/issues/169/
151+
# Fix for Python 3.12 CI. This can be removed after pybtex is replaced.
158152
session.install("setuptools", silent=False)
159153
session.install("-e", ".[all,docs]", silent=False)
160154
session.chdir("docs")

src/pybamm/input/parameters/lithium_ion/Ai2020.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def graphite_electrolyte_exchange_current_density_Dualfoil1998(
4545
4646
References
4747
----------
48-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
48+
.. [2] John Newman, Dualfoil
4949
5050
Parameters
5151
----------
@@ -219,7 +219,7 @@ def lico2_diffusivity_Dualfoil1998(sto, T):
219219
220220
References
221221
----------
222-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
222+
.. [1] John Newman, Dualfoil
223223
224224
Parameters
225225
----------
@@ -247,7 +247,7 @@ def lico2_electrolyte_exchange_current_density_Dualfoil1998(c_e, c_s_surf, c_s_m
247247
248248
References
249249
----------
250-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
250+
.. [2] John Newman, Dualfoil
251251
252252
Parameters
253253
----------

src/pybamm/input/parameters/lithium_ion/Marquis2019.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def graphite_mcmb2528_diffusivity_Dualfoil1998(sto, T):
99
1010
References
1111
----------
12-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
12+
.. [1] John Newman, Dualfoil
1313
1414
Parameters
1515
----------
@@ -40,7 +40,7 @@ def graphite_mcmb2528_ocp_Dualfoil1998(sto):
4040
4141
References
4242
----------
43-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
43+
.. [1] John Newman, Dualfoil
4444
"""
4545

4646
u_eq = (
@@ -68,7 +68,7 @@ def graphite_electrolyte_exchange_current_density_Dualfoil1998(
6868
6969
References
7070
----------
71-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
71+
.. [2] John Newman, Dualfoil
7272
7373
Parameters
7474
----------
@@ -134,7 +134,7 @@ def lico2_diffusivity_Dualfoil1998(sto, T):
134134
135135
References
136136
----------
137-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
137+
.. [1] John Newman, Dualfoil
138138
139139
Parameters
140140
----------
@@ -166,7 +166,7 @@ def lico2_ocp_Dualfoil1998(sto):
166166
167167
References
168168
----------
169-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
169+
.. [1] John Newman, Dualfoil
170170
.. [2] CM Doyle. Design and simulation of lithium rechargeable batteries,
171171
1995.
172172
@@ -200,7 +200,7 @@ def lico2_electrolyte_exchange_current_density_Dualfoil1998(c_e, c_s_surf, c_s_m
200200
201201
References
202202
----------
203-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
203+
.. [2] John Newman, Dualfoil
204204
205205
Parameters
206206
----------
@@ -269,7 +269,7 @@ def electrolyte_diffusivity_Capiglia1999(c_e, T):
269269
.. [1] C Capiglia et al. 7Li and 19F diffusion coefficients and thermal
270270
properties of non-aqueous electrolyte solutions for rechargeable lithium batteries.
271271
Journal of power sources 81 (1999): 859-862.
272-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
272+
.. [2] John Newman, Dualfoil
273273
274274
Parameters
275275
----------
@@ -302,7 +302,7 @@ def electrolyte_conductivity_Capiglia1999(c_e, T):
302302
.. [1] C Capiglia et al. 7Li and 19F diffusion coefficients and thermal
303303
properties of non-aqueous electrolyte solutions for rechargeable lithium batteries.
304304
Journal of power sources 81 (1999): 859-862.
305-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
305+
.. [2] John Newman, Dualfoil
306306
307307
Parameters
308308
----------

src/pybamm/input/parameters/lithium_ion/Mohtat2020.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def graphite_diffusivity_PeymanMPM(sto, T):
99
1010
References
1111
----------
12-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
12+
.. [1] John Newman, Dualfoil
1313
1414
Parameters
1515
----------
@@ -63,7 +63,7 @@ def graphite_electrolyte_exchange_current_density_PeymanMPM(c_e, c_s_surf, c_s_m
6363
6464
References
6565
----------
66-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
66+
.. [2] John Newman, Dualfoil
6767
6868
Parameters
6969
----------
@@ -126,7 +126,7 @@ def NMC_diffusivity_PeymanMPM(sto, T):
126126
127127
References
128128
----------
129-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
129+
.. [1] John Newman, Dualfoil
130130
131131
Parameters
132132
----------
@@ -257,7 +257,7 @@ def electrolyte_diffusivity_PeymanMPM(c_e, T):
257257
.. [1] C Capiglia et al. 7Li and 19F diffusion coefficients and thermal
258258
properties of non-aqueous electrolyte solutions for rechargeable lithium batteries.
259259
Journal of power sources 81 (1999): 859-862.
260-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
260+
.. [2] John Newman, Dualfoil
261261
262262
Parameters
263263
----------
@@ -290,7 +290,7 @@ def electrolyte_conductivity_PeymanMPM(c_e, T):
290290
.. [1] C Capiglia et al. 7Li and 19F diffusion coefficients and thermal
291291
properties of non-aqueous electrolyte solutions for rechargeable lithium batteries.
292292
Journal of power sources 81 (1999): 859-862.
293-
.. [2] http://www.cchem.berkeley.edu/jsngrp/fortran.html
293+
.. [2] John Newman, Dualfoil
294294
Parameters
295295
----------
296296
c_e: :class:`pybamm.Symbol`

src/pybamm/input/parameters/lithium_ion/Ramadass2004.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def graphite_mcmb2528_diffusivity_Dualfoil1998(sto, T):
99
1010
References
1111
----------
12-
.. [1] http://www.cchem.berkeley.edu/jsngrp/fortran.html
12+
.. [1] John Newman, Dualfoil
1313
1414
Parameters
1515
----------

0 commit comments

Comments
 (0)