Merge commit '1bd9eea4d7bc9cfb367ade67b9819831c22a8693' into feature_91

.editorconfig

@@ -0,0 +1,7 @@
+
+[*.{cs,vb}]
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = true

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "nuget"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

Wave.sln

@@ -11,6 +11,11 @@ Project("{F184B08F-C81C-45F6-A57F-5ABD9991F28F}") = "Wave.Examples", "examples\W
 EndProject
 Project("{54435603-DBB4-11D2-8724-00A0C9A8B90C}") = "Wave.Setup", "setup\Wave.Setup.vdproj", "{68EAC8A5-045C-467E-814F-4BFCA71B9B8F}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{DBDDE525-114F-4271-83E0-590F2C96D8B4}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64

docs/articles/analysis.md

@@ -15,4 +15,4 @@ Example `Analysis\TestAnalysis.vb`:
 
 Add the new analysis function to the AnalysisFactory (file `Analysis\AnalysisFactory.vb`). The locations to edit are highlighted below and marked with `EDIT THIS`.
 
-[!code-vb[](../../source/Analysis/AnalysisFactory.vb?highlight=39,73-74,128-129)]
+[!code-vb[](../../source/Analysis/AnalysisFactory.vb?highlight=40,76-77,134-135)]

docs/articles/intro.md

@@ -4,19 +4,38 @@
 1. Start Visual Studio and go to *Extras -> Options -> NuGet Package Manager -> Package Sources*
 1. Add `https://api.nuget.org/v3/index.json` to package sources
 1. Clone BlueM.Wave source code from https://github.com/bluemodel/BlueM.Wave
-1. Clone BlueM.Datasets from https://github.com/bluemodel/BlueM.Datasets
-1. To use TeeChart Pro trial version, create an empty file `BlueM.Wave\source\My Project\TeeChart.licenses` or remove the corresponding entry from the project in Visual Studio
+1. Copy a valid TeeChart Pro license file to `BlueM.Wave\source\My Project\TeeChart.licenses` (see below for instructions on using the evaluation version of TeeChart for testing purposes)
 1. Open `Wave.sln` in Visual Studio
-1. Run Tests (*Test -> Run all Tests*)
-1. Run Project (*Debug -> Start Debugging*)
+1. Set `Wave` as the startup project
+1. Run project (*Debug -> Start Debugging*)
+
+Optional setup steps:
+* To run tests in `Wave.Tests`:
+  * Clone BlueM.Datasets from https://github.com/bluemodel/BlueM.Datasets into the same parent directory as BlueM.Wave
+  * Run Tests (*Test -> Run all Tests*), see below for details
+* To build the installer project `Wave.Setup`:
+  * Install the extension [Microsoft Visual Studio Installer Projects 2022](https://marketplace.visualstudio.com/items?itemName=VisualStudioClient.MicrosoftVisualStudio2022InstallerProjects), see below for details
 
 ## TeeChart license
-BlueM.Wave uses [TeeChart .NET](https://www.steema.com/product/net) for all charts. To compile a fully functional version of BlueM.Wave, you need a TeeChart .NET Pro license.
+BlueM.Wave uses [TeeChart .NET](https://www.steema.com/product/net) for all charts. To compile a fully functional version of BlueM.Wave, you need a valid TeeChart .NET Pro license file located at `BlueM.Wave\source\My Project\TeeChart.licenses`.
 
-For testing purposes, you can use the evaluation version of TeeChart creating an empty file `BlueM.Wave\source\My Project\TeeChart.licenses` or removing the corresponding entry from the project in Visual Studio. This will allow you to compile, but any charts will be displayed with a watermark.
+For testing purposes, you can use the evaluation version of TeeChart by creating an empty text file at `BlueM.Wave\source\My Project\TeeChart.licenses` or by excluding the corresponding entry `My Project\TeeChart.licenses` from the Wave project in Visual Studio. This will allow you to compile, but any charts will be displayed with a watermark.
 
 ## Testing
-The repository contains an assembly `Wave.Tests` for unit testing. Tests can be run from within Visual Studio. To add new tests, follow the pattern of the existing ones and/or refer to the [MSTest framework docs](https://docs.microsoft.com/en-us/visualstudio/test/using-microsoft-visualstudio-testtools-unittesting-members-in-unit-tests?view=vs-2022).
+The repository contains an assembly `Wave.Tests` for unit testing. 
+
+Some of the tests use test data from the [BlueM.Datasets](https://github.com/bluemodel/BlueM.Datasets) repository, which needs to be checked out alongside BlueM.Wave in the same parent folder.
+
+There are two ways to run tests:
+* from within Visual Studio using the *Text Explorer* window (see also [this article](https://learn.microsoft.com/en-us/visualstudio/test/run-unit-tests-with-test-explorer?view=vs-2022))
+* from the command-line with the following command (see also [this arcticle](https://learn.microsoft.com/en-us/visualstudio/test/vstest-console-options?view=vs-2022)):
+```bat
+vstest.console.exe BlueM.Wave\tests\bin\x64\Debug\Wave.Tests.dll /Settings:BlueM.Wave\tests\tests.runsettings
+```
+
+To add new tests, follow the pattern of the existing ones and/or refer to the [MSTest framework docs](https://docs.microsoft.com/en-us/visualstudio/test/using-microsoft-visualstudio-testtools-unittesting-members-in-unit-tests?view=vs-2022).
+
+All tests defined in `Wave.Tests` are automatically run in a GitHub action whenever a push to the master branch or to a pull request occurs (see [workflow file](https://github.com/bluemodel/BlueM.Wave/blob/master/.github/workflows/run-tests.yml)).
 
 ## Debug log messages
 Debug log messages can be created with `Log.AddLogEntry(levels.debug, "message")` and are only visible in the log if the application setting `loggingLevel` is set to `debug`.
@@ -42,7 +61,7 @@ The repository contains a project `Wave.Examples` with some examples of API usag
 See the [API documentation](../api/index.md)
 
 ## Building an installer
-An installer (.msi) for BlueM.Wave can be built using the `Wave.Setup` project located at `setup\Wave.Setup.vdproj` which is a [Visual Studio Installer Project](https://marketplace.visualstudio.com/items?itemName=VisualStudioClient.MicrosoftVisualStudio2022InstallerProjects) (see [docs](https://aka.ms/vdproj-docs)).
+An installer (.msi) for BlueM.Wave can be built using the `Wave.Setup` project located at `setup\Wave.Setup.vdproj`. This is a Visual Studio Installer Project which requires a [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=VisualStudioClient.MicrosoftVisualStudio2022InstallerProjects) to be installed (see [docs](https://aka.ms/vdproj-docs)).
 
 ## Releases
 To create a new release:

docs/docfx.json

@@ -71,6 +71,7 @@
     "noLangKeyword": false,
     "keepFileLink": false,
     "cleanupCacheHistory": false,
-    "disableGitFeatures": false
+    "disableGitFeatures": false,
+	"EnumSortOrder": "declaringOrder"
   }
 }

examples/Examples.vb

@@ -1,4 +1,4 @@
-Public Class Examples
+Public Class Examples
 
     ''' <summary>
     ''' Path to the time series file
@@ -149,6 +149,12 @@
         Console.WriteLine("End date: " & ts.EndDate)
         Console.WriteLine("Average: " & ts.Average)
 
+        'set some custom display options
+        ts.DisplayOptions.Color = Color.Red
+        ts.DisplayOptions.LineStyle = Drawing2D.DashStyle.Dash
+        ts.DisplayOptions.LineWidth = 1
+        ts.DisplayOptions.ShowPoints = True
+
         'import the series in Wave
         Wave1.Import_Series(ts)