|
|
| Line 1: |
Line 1: |
| {{Wave_nav}} | | {{Wave_nav}} |
|
| |
|
| ==Getting started==
| | BlueM.Wave is written in VB.NET (currently targeting the .NET Framework 4.8). |
| [[File:VisualStudio NuGet.png|thumb|right|400px|NuGet options in Visual Studio]]
| |
| # Download [https://visualstudio.microsoft.com/de/downloads/ Visual Studio Installer (Community Edition)]
| |
| # Install Visual Studio with '''.NET-desktop development tools'''
| |
| # Start Visual Studio and go to ''Extras -> Options -> NuGet Package Manager -> Package Sources''
| |
| # Add <code><nowiki>https://api.nuget.org/v3/index.json</nowiki></code> to package sources
| |
| # Clone BlueM.Wave source code from https://github.com/bluemodel/BlueM.Wave
| |
| # Clone BlueM.Datasets from https://github.com/bluemodel/BlueM.Datasets
| |
| # To use TeeChart Pro trial version, either create the following two empty files or remove the corresponding entries from the project in Visual Studio:
| |
| #*<code>BlueM.Wave\My Project\TeeChart.licenses</code>
| |
| #*<code>BlueM.Wave\Tests\Wave.Tests\My Project\TeeChart.licenses</code>
| |
| # Open <code>Wave.sln</code> in Visual Studio
| |
| # Run Tests (''Test -> Run all Tests'')
| |
| # Run Project (''Debug -> Start Debugging'')
| |
|
| |
|
| ==Issues==
| | The source code and issues are managed on GitHub: https://github.com/bluemodel/BlueM.Wave |
| Issues are managed on GitHub: https://github.com/bluemodel/BlueM.Wave/issues
| |
|
| |
|
| ==TeeChart license==
| | Developer/API docs are hosted here: https://bluemodel.github.io/BlueM.Wave/ |
| BlueM.Wave uses [https://www.steema.com/product/net TeeChart .NET] for all charts. To compile BlueM.Wave, you need a TeeChart .NET Pro license.
| |
| | |
| For testing purposes, you can use the evaluation version of TeeChart by either removing the file <code>My Project\TeeChart.licenses</code> from the project within Visual Studio or by adding an empty file in its place. This will allow you to compile, but any charts will be displayed with a watermark.
| |
| | |
| ==API==
| |
| * [[Wave:API|API documentation]]
| |
| | |
| ==Instructions==
| |
| * [[Wave:AnalysisFactory|Creating a new analysis function]]
| |
| | |
| ==Testing==
| |
| The repositoy contains an assembly <code>Wave.Tests</code> 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 [https://docs.microsoft.com/en-us/visualstudio/test/using-microsoft-visualstudio-testtools-unittesting-members-in-unit-tests?view=vs-2022 MSTest framework docs].
| |
|
| |
|
| [[Category:BlueM.Wave]] | | [[Category:BlueM.Wave]] |
