From 1e95c3597c245749ad6d6f3e35ff6cb16ac9cab3 Mon Sep 17 00:00:00 2001 From: Christoph Ruegg Date: Sun, 3 May 2020 11:26:43 +0200 Subject: [PATCH] Math.NET Numerics: 4.9.1 docs update --- Build.html | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/Build.html b/Build.html index 2e96d6ed..fbda6688 100644 --- a/Build.html +++ b/Build.html @@ -65,25 +65,21 @@ manually with the build scripts.

-

VisualStudio or Xamarin Studio

-

We clearly separate dependency management from the IDE, you should therefore +

VisualStudio and other IDEs

+

We clearly separate dependency management from the IDE and therefore recommend to run restore.cmd or restore.sh once after every git checkout in order to restore the dependencies exactly as defined. Otherwise Visual Studio and other IDEs may fail to compile or provide correct IntelliSense.

Tests can be run with the usual integrated NUnit test runners or ReSharper.

Command Line Tools

Instead of a compatible IDE you can also build the solutions directly with -the .NET Core SDK, with MsBuild or on Mono with XBuild. You may need to run restore.cmd or -restore.sh before, once after every git checkout in order to restore the dependencies.

+the .NET Core SDK build tools. You may need to run restore.cmd or restore.sh +before, once after every git checkout in order to restore the dependencies.

-
1: 
 2: 
-3: 
-4: 
 
restore.cmd (or restore.sh)             # restore dependencies (once)
-dotnet build MathNet.Numerics.sln       # with .NET Core SDK
-msbuild MathNet.Numerics.sln            # with MsBuild
-xbuild MathNet.Numerics.sln             # with Mono
+
restore.cmd (or ./restore.sh)
+dotnet build MathNet.Numerics.sln
@@ -92,7 +88,7 @@ the .NET Core SDK, with MsBuild or on Mono with XBuild. You may need to run FAKE.

FAKE itself is not included in the repository but it will download and bootstrap itself automatically when build.cmd is run the first time. Note that this step -is not required when using Visual Studio or msbuild directly.

+is not required when using Visual Studio or the .NET Core SDK directly.

 1: 
  2: 
  3: 
@@ -112,10 +108,10 @@ is not required when using Visual Studio or msbuild direct
 build.cmd    # normal build and unit tests, when using Windows CMD shell.
 
 ./build.sh build              # normal build
-./build.sh build strongname   # normal build and also build strong named variant
+./build.sh build strongname   # normal build and also build strong-named variant
 
-./build.sh test          # normal build (.Net 4.0), run unit tests
-./build.sh test quick    # normal build (.Net 4.0), run unit tests except long running ones
+./build.sh test          # normal build, run unit tests
+./build.sh test quick    # normal build, run unit tests except long running ones
 
 ./build.sh clean         # cleanup build artifacts
 ./build.sh docs          # generate documentation
@@ -209,12 +205,18 @@ these packages as well, with the following prefixes:

 
 
Example: build.sh DataBuild

 
Intel MKL on Windows

-
The build expects that either Intel Parallel Studio 2020 (with the Intel Compiler)
-or Intel Math Kernel Library 2020 is installed. If you run into an error with mkl_link_tool.exe
-you may need to patch a targets file, see MKL 2020.1, VS2019 linking bug .

-
The build is targeting Windows 10 SDK (10.0.17763.0) and the v142 platform toolset,
-both of which can be installed as individual components in the Visual Studio Installer,
-together with the Desktop development with C++ workload.

+
Building the Intel MKL native provider for Windows requires additionally:

+
    
+
  • Either Intel Parallel Studio 2020 or Intel Math Kernel Library 2020 is installed
    • 
+
  • 
+Visual Studio 2019, with the following options
+
      
+
    • Desktop development with C++ workload
      • 
+
    • Windows 10 SDK (10.0.17763.0)
      • 
+
    • MSVC v142 - VS 2019 C++ x64/x86 build tools
      • 
+
    
+
    • 
+

 
The build can then be triggered by calling:

 
1: 
 2: 
@@ -226,6 +228,8 @@ together with the Desktop development with C++ workload.

 

 

 

+
If you run into an error with mkl_link_tool.exe you may need to patch a targets file,
+see MKL 2020.1, VS2019 linking bug .

 
The build puts the binaries to out/MKL/Windows/x64 (and x86), the NuGet package
 to out/MKL/NuGet and a Zip archive to out/MKL/Zip. You can directly use the provider from
 there by setting Control.NativeProviderPath to the full path pointing to out/MKL/Windows/;