fixed the broken links in doc

BattMoTeam · Jan 30, 2024 · bc3bca9 · bc3bca9
1 parent e0bf6af
commit bc3bca9
Show file tree

Hide file tree

Showing 18 changed files with 64 additions and 64 deletions.
diff --git a/Documentation/_static/notebooks/tutorial_1_a_simple_p2d_model_live.html b/Documentation/_static/notebooks/tutorial_1_a_simple_p2d_model_live.html
diff --git a/Documentation/_static/notebooks/tutorial_2_changing_control_protocol_live.html b/Documentation/_static/notebooks/tutorial_2_changing_control_protocol_live.html
diff --git a/Documentation/_static/notebooks/tutorial_3_modify_structural_parameters_live.html b/Documentation/_static/notebooks/tutorial_3_modify_structural_parameters_live.html
diff --git a/Documentation/_static/notebooks/tutorial_4_modify_material_parameters_live.html b/Documentation/_static/notebooks/tutorial_4_modify_material_parameters_live.html
diff --git a/Documentation/_static/notebooks/tutorial_5_simulate_CCCV_cycling_live.html b/Documentation/_static/notebooks/tutorial_5_simulate_CCCV_cycling_live.html
diff --git a/Documentation/_static/notebooks/tutorial_6_simulate_thermal_performance_live.html b/Documentation/_static/notebooks/tutorial_6_simulate_thermal_performance_live.html
diff --git a/Documentation/_static/notebooks/tutorial_7_a_simple_p4d_model_live.html b/Documentation/_static/notebooks/tutorial_7_a_simple_p4d_model_live.html
diff --git a/Documentation/_static/notebooks/tutorial_8_simulate_a_multilayer_pouch_cell_live.html b/Documentation/_static/notebooks/tutorial_8_simulate_a_multilayer_pouch_cell_live.html
diff --git a/Documentation/_static/notebooks/tutorial_9_simulate_a_cylindrical_cell_live.html b/Documentation/_static/notebooks/tutorial_9_simulate_a_cylindrical_cell_live.html
diff --git a/Documentation/basicusage.rst b/Documentation/basicusage.rst
@@ -305,39 +305,39 @@ The notebooks can be found in the :battmofile:`Examples/Notebooks` directory or
    * - Tutorial 1
      - **Your first BattMo model**
      - `view <_static/notebooks/tutorial_1_a_simple_p2d_model_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_1_a_simple_p2d_model_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_1_a_simple_p2d_model_live.mlx>`
    * - Tutorial 2
      - **Change the Control Protocol**
      - `view <_static/notebooks/tutorial_2_changing_control_protocol_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_2_changing_control_protocol_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_2_changing_control_protocol_live.mlx>`
    * - Tutorial 3
      - **Modify Structural Parameters**
      - `view <_static/notebooks/tutorial_3_modify_structural_parameters_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_3_modify_structural_parameters_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_3_modify_structural_parameters_live.mlx>`
    * - Tutorial 4
      - **Modify Material Parameters**
      - `view <_static/notebooks/tutorial_4_modify_material_parameters_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_4_modify_material_parameters_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_4_modify_material_parameters_live.mlx>`
    * - Tutorial 5
      - **Simulate CC-CV cycling**
      - `view <_static/notebooks/tutorial_5_simulate_CCCV_cycling_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_5_simulate_CCCV_cycling_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_5_simulate_CCCV_cycling_live.mlx>`
    * - Tutorial 6
      - **Simulate Thermal Performance**
      - `view <_static/notebooks/tutorial_6_simulate_thermal_performance_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_6_simulate_thermal_performance_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_6_simulate_thermal_performance_live.mlx>`
    * - Tutorial 7
      - **A Simple P4D Simulation**
      - `view <_static/notebooks/tutorial_7_a_simple_p4d_model_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_7_a_simple_p4d_model_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_7_a_simple_p4d_model_live.mlx>`
    * - Tutorial 8
      - **Simulate a Multi-Layer Pouch cell**
      - `view <_static/notebooks/tutorial_8_simulate_a_multilayer_pouch_cell_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_8_simulate_a_multilayer_pouch_cell_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_8_simulate_a_multilayer_pouch_cell_live.mlx>`
    * - Tutorial 9
      - **Simulate a Cylindrical Cell**
      - `view <_static/notebooks/tutorial_9_simulate_a_cylindrical_cell_live.html>`__
-     - :battmorawfile:`download <Examples/NoteBooks/tutorial_9_simulate_a_cylindrical_cell_live.mlx>`
+     - :battmorawfile:`download <Examples/Notebooks/tutorial_9_simulate_a_cylindrical_cell_live.mlx>`
 
 
 Next Steps

diff --git a/Documentation/controlinput.rst b/Documentation/controlinput.rst
@@ -167,7 +167,7 @@ control.
 
 We have to setup a model and an initial state. We use the function :battmo:`setupModelFromJson` to setup the model from
 a given json input. We load the sample input function we have used before, see source
-:battmofile:`here<Examples/jsondatafiles/sample_input.json>`. We replace the :code:`Control` field with a structure with
+:battmofile:`here<Examples/JsonDataFiles/sample_input.json>`. We replace the :code:`Control` field with a structure with
 a :code:`controlPolicy` given by a current control (:code:`CC`). We change the initial state of charge value (SOC) to
 0.5 so that we do not hit the upper current voltage value (the SOC given in the sample json is 0.99).
 

diff --git a/Documentation/json.rst b/Documentation/json.rst
@@ -20,7 +20,7 @@ The main Simulation schema contains schemas for
 .. note::
 
    The different schemas may have common object. In the validation process, each schema is handled parallelly. The
-   function :battmofile:`mergeJsonStructs` can be used to compose different json files.
+   function :battmo:`mergeJsonStructs` can be used to compose different json files.
 
 For example a component (say the electolyte) has its geometrical and material properties specified in two separate
 schemas. Having separate schemas clarify the presentation and corresponds also to a convenient way to organize the

diff --git a/Documentation/juliabridge.rst b/Documentation/juliabridge.rst
@@ -94,7 +94,7 @@ The json input :code:`p2d_40_jl_ud.json` contains functional parameters. For exa
              "c",
              "T"]}} 
 
-The full listing is available :battmofile:`here<Examples/julia/jsonfiles/p2d_40_jl_ud.json>`. For the :code:`function`
+The full listing is available :battmofile:`here<Examples/JsonDataFiles/p2d_40_jl_ud.json>`. For the :code:`function`
 property, the string that is given to compute the corresponding value (ionic conductivity in the electrolyte in the
 snippet above) should be written with a Julia syntax, as it is passed directly to the julia solver. This should not be a
 big issue for Matlab users because the Julia syntax is very close to Matlab for such arithmetic expressions. We plan to

diff --git a/Documentation/mrst.rst.inc b/Documentation/mrst.rst.inc
@@ -39,5 +39,5 @@ users.
 
 see :ref:`here<visualization>`.              
 
-.. _MRSTwebpage: https://www.sintef.no/Projectweb/MRSTwebpage/
+.. _MRSTwebpage: https://www.sintef.no/projectweb/mrst/
 
diff --git a/Documentation/optimisation.rst b/Documentation/optimisation.rst
@@ -91,7 +91,7 @@ In this example we will fit five parameters:
 
 To set up these parameters in the fitting, we use the `ModelParameter`
 class in MRST. As can be seen in the source code found at
-:battmofile:`ModelParameter<Externals/mrst/mrst-autodiff/optimization/utils/ModelParameter.m>`,
+:mrstfile:`ModelParameter<mrst-autodiff/optimization/utils/ModelParameter.m>`,
 there are a several options that can be set. The most important ones are the ones used here:
 
 * the name of the parameter (arbitrary)

diff --git a/Documentation/utils/util.el b/Documentation/utils/util.el
@@ -26,12 +26,12 @@ Temp."
 
 ;; example
 (defun editfunc ()
-  (while (re-search-forward (rx "Introduction") nil t)
-    (replace-match "hello")
+  (while (re-search-forward (rx "plotBatteryMesh") nil t)
+    (replace-match "plotBatteryGrid")
     )
   )
 
 ;; example
-;; (edit-mlx "../../Examples/NoteBooks/tutorial_2_changing_control_protocol_live.mlx" #'editfunc)
+(edit-mlx "../../Examples/Notebooks/tutorial_7_a_simple_p4d_model_live.mlx" #'editfunc)
 
 
diff --git a/Examples/Notebooks/tutorial_1_a_simple_p2d_model_live.mlx b/Examples/Notebooks/tutorial_1_a_simple_p2d_model_live.mlx
diff --git a/Examples/Notebooks/tutorial_7_a_simple_p4d_model_live.mlx b/Examples/Notebooks/tutorial_7_a_simple_p4d_model_live.mlx
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,5 +39,5 @@ users.

		see :ref:`here<visualization>`.

		.. _MRSTwebpage: https://www.sintef.no/Projectweb/MRSTwebpage/
		.. _MRSTwebpage: https://www.sintef.no/projectweb/mrst/