Added video workshop and fixed typo in example meshes.

afsa · Jun 22, 2022 · 422135b · 422135b
1 parent 88f416a
commit 422135b
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+## v1.0.1 (2022-06-22)
+
+- Added video workshop link to README.md.
+- Fixed voltage probe variable name typo in example meshes.
diff --git a/README.md b/README.md
@@ -11,7 +11,16 @@ current crowding effect.
 
 ## Getting started
 
-Please refer to the [documentation](https://super-detector-py.readthedocs.io).
+Please refer to the [documentation](https://super-detector-py.readthedocs.io) 
+for information on how to get started with SuperDetectorPy.
+
+A video demonstrating how to get started is available on 
+[KTH play](https://play.kth.se/media/SuperDetectorPy+workshop/0_udx69wxg).
+
+## Documentation
+
+Documentation is available on 
+[Read the Docs](https://super-detector-py.readthedocs.io).
 
 ## License and citing
 

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -26,7 +26,7 @@ Alternatively, in a Linux terminal run
 
 .. code-block:: bash
 
-    wget -O super-detector-py.zip https://github.com/afsa/super-detector-py/archive/refs/tags/v1.0.0.zip && \
+    wget -O super-detector-py.zip https://github.com/afsa/super-detector-py/archive/refs/tags/v1.0.1.zip && \
     unzip super-detector-py.zip && \
     rm super-detector-py.zip
 

diff --git a/meshing/circle_turnaround_mesh.m b/meshing/circle_turnaround_mesh.m
@@ -83,8 +83,8 @@
 clf()
 pdegplot(model, 'EdgeLabels','on')
 hold on
-plot(voltage_start(1), voltage_start(2), 'o')
-plot(voltage_end(1), voltage_end(2), 'o')
+plot(voltageStart(1), voltageStart(2), 'o')
+plot(voltageEnd(1), voltageEnd(2), 'o')
 
 
 %% Generate mesh

diff --git a/meshing/ellipse_turnaround_mesh.m b/meshing/ellipse_turnaround_mesh.m
@@ -83,8 +83,8 @@
 clf()
 pdegplot(model, 'EdgeLabels','on')
 hold on
-plot(voltage_start(1), voltage_start(2), 'o')
-plot(voltage_end(1), voltage_end(2), 'o')
+plot(voltageStart(1), voltageStart(2), 'o')
+plot(voltageEnd(1), voltageEnd(2), 'o')
 
 
 %% Generate mesh

diff --git a/meshing/straight_mesh.m b/meshing/straight_mesh.m
@@ -63,8 +63,8 @@
 clf()
 pdegplot(model, 'EdgeLabels','on')
 hold on
-plot(voltage_start(1), voltage_start(2), 'o')
-plot(voltage_end(1), voltage_end(2), 'o')
+plot(voltageStart(1), voltageStart(2), 'o')
+plot(voltageEnd(1), voltageEnd(2), 'o')
 
 
 %% Generate mesh