tsai
/
mathnet-numerics
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Docs: xbuild and msbuild are no longer supported thus no longer mention them. Refine MKL section.

uap-experimental
Christoph Ruegg 6 years ago
parent
2a774e61bf
commit
bca56038cf
1 changed files with 22 additions and 21 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 43
      docs/content/Build.md

43
docs/content/Build.md
View File

@ -10,10 +10,10 @@ System Requirements
* .NET Core SDK 3.1.1 ([download](https://dotnet.microsoft.com/download/dotnet-core/3.1)) * .NET Core SDK 3.1.1 ([download](https://dotnet.microsoft.com/download/dotnet-core/3.1))
VisualStudio or Xamarin Studio VisualStudio and other IDEs
------------------------------ ---------------------------
We clearly separate dependency management from the IDE, you should therefore 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 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 the dependencies exactly as defined. Otherwise Visual Studio and other IDEs
may fail to compile or provide correct IntelliSense. may fail to compile or provide correct IntelliSense.
@ -24,13 +24,11 @@ Command Line Tools
------------------ ------------------
Instead of a compatible IDE you can also build the solutions directly with 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 the .NET Core SDK build tools. You may need to run `restore.cmd` or `restore.sh`
`restore.sh` before, once after every git checkout in order to restore the dependencies. before, once after every git checkout in order to restore the dependencies.
restore.cmd (or restore.sh) # restore dependencies (once) restore.cmd (or ./restore.sh)
dotnet build MathNet.Numerics.sln # with .NET Core SDK dotnet build MathNet.Numerics.sln
msbuild MathNet.Numerics.sln # with MsBuild
xbuild MathNet.Numerics.sln # with Mono
FAKE FAKE
---- ----
@ -40,21 +38,21 @@ reference, NuGet and Zip packages is using [FAKE](https://fsharp.github.io/FAKE/
FAKE itself is not included in the repository but it will download and bootstrap 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 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.
./build.sh # normal build and unit tests, when using bash shell on Windows or Linux. ./build.sh # normal build and unit tests, when using bash shell on Windows or Linux.
build.cmd # normal build and unit tests, when using Windows CMD shell. build.cmd # normal build and unit tests, when using Windows CMD shell.
./build.sh build # normal build ./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 # normal build, run unit tests
./build.sh test quick # normal build (.Net 4.0), run unit tests except long running ones ./build.sh test quick # normal build, run unit tests except long running ones
./build.sh clean # cleanup build artifacts ./build.sh clean # cleanup build artifacts
./build.sh docs # generate documentation ./build.sh docs # generate documentation
./build.sh api # generate api reference ./build.sh api # generate api reference
./build.sh all # build, test, docs, api reference ./build.sh all # build, test, docs, api reference
If the build or tests fail claiming that FSharp.Core was not be found, see If the build or tests fail claiming that FSharp.Core was not be found, see
@ -142,20 +140,23 @@ Example: `build.sh DataBuild`
Intel MKL on Windows Intel MKL on Windows
-------------------- --------------------
The build expects that either Intel Parallel Studio 2020 (with the Intel Compiler) Building the Intel MKL native provider for Windows requires additionally:
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 ](https://software.intel.com/en-us/forums/intel-math-kernel-library/topic/851578).
The build is targeting `Windows 10 SDK (10.0.17763.0)` and the `v142` platform toolset, * Either Intel Parallel Studio 2020 or Intel Math Kernel Library 2020 is installed
both of which can be installed as individual components in the Visual Studio Installer, * Visual Studio 2019, with the following options
together with the `Desktop development with C++` workload. * 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: The build can then be triggered by calling:
./build.sh MklWinBuild // build both 32 and 64 bit variants ./build.sh MklWinBuild // build both 32 and 64 bit variants
./build.sh MklTest // run all tests with the MKL provider enforced ./build.sh MklTest // run all tests with the MKL provider enforced
./build.sh MklWinAll // build and run tests ./build.sh MklWinAll // build and run tests
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 ](https://software.intel.com/en-us/forums/intel-math-kernel-library/topic/851578).
The build puts the binaries to `out/MKL/Windows/x64` (and `x86`), the NuGet package 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 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/`; there by setting `Control.NativeProviderPath` to the full path pointing to `out/MKL/Windows/`;

Write Preview
Loading…
Cancel
Save