From 422135bd3f8e5e08dab53e86e430c4d41fec78b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20J=C3=B6nsson?= Date: Wed, 22 Jun 2022 11:10:01 +0200 Subject: [PATCH] Added video workshop and fixed typo in example meshes. --- CHANGELOG.md | 6 ++++++ README.md | 11 ++++++++++- docs/source/install.rst | 2 +- meshing/circle_turnaround_mesh.m | 4 ++-- meshing/ellipse_turnaround_mesh.m | 4 ++-- meshing/straight_mesh.m | 4 ++-- 6 files changed, 23 insertions(+), 8 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..eb296f8 --- /dev/null +++ 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. \ No newline at end of file diff --git a/README.md b/README.md index 2d07711..6f8c84e 100644 --- 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 index 3672539..3695e41 100644 --- 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 index 6ed23ff..d3a99ca 100644 --- 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 index 2207d3a..fd90c30 100644 --- 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 index 3f5264e..b5e9fe2 100644 --- 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