Skip to content

Commit

Permalink
Fixed broken link renders in SPM example notebook (pybamm-team#4185)
Browse files Browse the repository at this point in the history
* fixed broken link references in SPM example notebook

* changed links from latest to stable

---------

Co-authored-by: Agriya Khetarpal <[email protected]>
  • Loading branch information
santacodes and agriyakhetarpal authored Jun 18, 2024
1 parent e5fe293 commit 7d3ef99
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/source/examples/notebooks/models/SPM.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The model object is a subtype of [`pybamm.BaseModel`](https://docs.pybamm.org/en/latest/source/api/models/base_models/base_model.html), and contains all the equations that define this particular model. For example, the `rhs` dict contained in `model` has a dictionary mapping variables such as $c_n$ to the equation representing its rate of change with time (i.e. $\\partial{c_n}/\\partial{t}$). We can see this explicitly by visualising this entry in the `rhs` dict:"
"The model object is a subtype of [pybamm.BaseModel](https://docs.pybamm.org/en/stable/source/api/models/base_models/base_model.html), and contains all the equations that define this particular model. For example, the `rhs` dict contained in `model` has a dictionary mapping variables such as $c_n$ to the equation representing its rate of change with time (i.e. $\\partial{c_n}/\\partial{t}$). We can see this explicitly by visualising this entry in the `rhs` dict:"
]
},
{
Expand Down Expand Up @@ -141,7 +141,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We need a geometry in which to define our model equations. In pybamm this is represented by the [`pybamm.Geometry`](https://docs.pybamm.org/en/latest/source/api/geometry/index.html) class. In this case we use the default geometry object defined by the model"
"We need a geometry in which to define our model equations. In pybamm this is represented by the [pybamm.Geometry](https://docs.pybamm.org/en/stable/source/api/geometry/index.html) class. In this case we use the default geometry object defined by the model"
]
},
{
Expand Down Expand Up @@ -202,7 +202,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Both the model equations and the geometry include parameters, such as $L_p$. We can substitute these symbolic parameters in the model with values by using the [`pybamm.ParameterValues`](https://docs.pybamm.org/en/latest/source/api/parameters/parameter_values.html) class, which takes either a python dictionary or CSV file with the mapping between parameter names and values. Rather than create our own instance of `pybamm.ParameterValues`, we will use the default parameter set included in the model"
"Both the model equations and the geometry include parameters, such as $L_p$. We can substitute these symbolic parameters in the model with values by using the [pybamm.ParameterValues](https://docs.pybamm.org/en/stable/source/api/parameters/parameter_values.html) class, which takes either a python dictionary or CSV file with the mapping between parameter names and values. Rather than create our own instance of `pybamm.ParameterValues`, we will use the default parameter set included in the model"
]
},
{
Expand Down Expand Up @@ -237,7 +237,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The next step is to mesh the input geometry. We can do this using the [`pybamm.Mesh`](https://docs.pybamm.org/en/latest/source/api/meshes/index.html) class. This class takes in the geometry of the problem, and also two dictionaries containing the type of mesh to use within each domain of the geometry (i.e. within the positive or negative electrode domains), and the number of mesh points. \n",
"The next step is to mesh the input geometry. We can do this using the [pybamm.Mesh](https://docs.pybamm.org/en/stable/source/api/meshes/index.html) class. This class takes in the geometry of the problem, and also two dictionaries containing the type of mesh to use within each domain of the geometry (i.e. within the positive or negative electrode domains), and the number of mesh points. \n",
"\n",
"The default mesh types and the default number of points to use in each variable for the SPM are:"
]
Expand Down Expand Up @@ -310,7 +310,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The next step is to discretise the model equations using this mesh. We do this using the [`pybamm.Discretisation`](https://docs.pybamm.org/en/latest/source/api/spatial_methods/discretisation.html) class, which takes both the mesh we have already created, and a dictionary of spatial methods to use for each geometry domain. For the case of the SPM, we use the following defaults for the spatial discretisation methods:"
"The next step is to discretise the model equations using this mesh. We do this using the [pybamm.Discretisation](https://docs.pybamm.org/en/stable/source/api/spatial_methods/discretisation.html) class, which takes both the mesh we have already created, and a dictionary of spatial methods to use for each geometry domain. For the case of the SPM, we use the following defaults for the spatial discretisation methods:"
]
},
{
Expand Down Expand Up @@ -1118,7 +1118,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "pybamm",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -1132,7 +1132,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.12.3"
},
"toc": {
"base_numbering": 1,
Expand All @@ -1154,5 +1154,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}

0 comments on commit 7d3ef99

Please sign in to comment.