Wave:Development: Difference between revisions

From BlueM
Jump to navigation Jump to search
(Testing)
(Added getting started section)
Line 1: Line 1:
{{Wave_nav}}
{{Wave_nav}}


==Source code==
==Getting started==
Source code and issues are managed on GitHub: https://github.com/bluemodel
[[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'')


==Compilation==
==Issues==
Compiling BlueM.Wave requires a [https://www.steema.com/product/net TeeChart .NET] Pro license.
Issues are managed on GitHub: https://github.com/bluemodel/BlueM.Wave/issues


For testing purposes, you can use the evaluation version of TeeChart by removing the (missing) file <code>My Project\TeeChart.licenses</code> from the project within Visual Studio. This will allow you to compile, but any charts will be displayed with a watermark.
==TeeChart license==
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==
==API==

Revision as of 01:17, 2 October 2022

Wave.png Wave | Download | Development

Getting started

NuGet options in Visual Studio
  1. Download Visual Studio Installer (Community Edition)
  2. Install Visual Studio with .NET-desktop development tools
  3. Start Visual Studio and go to Extras -> Options -> NuGet Package Manager -> Package Sources
  4. Add https://api.nuget.org/v3/index.json to package sources
  5. Clone BlueM.Wave source code from https://github.com/bluemodel/BlueM.Wave
  6. Clone BlueM.Datasets from https://github.com/bluemodel/BlueM.Datasets
  7. To use TeeChart Pro trial version, either create the following two empty files or remove the corresponding entries from the project in Visual Studio:
    • BlueM.Wave\My Project\TeeChart.licenses
    • BlueM.Wave\Tests\Wave.Tests\My Project\TeeChart.licenses
  8. Open Wave.sln in Visual Studio
  9. Run Tests (Test -> Run all Tests)
  10. Run Project (Debug -> Start Debugging)

Issues

Issues are managed on GitHub: https://github.com/bluemodel/BlueM.Wave/issues

TeeChart license

BlueM.Wave uses 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 My Project\TeeChart.licenses 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

Instructions

Testing

The repositoy 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.