Browse Source

Docs: NuGet & Binaries, simplified home page

cuda
Christoph Ruegg 12 years ago
parent
commit
850a7af28e
  1. 2
      MathNet.Numerics.sln
  2. 4
      docs/content/Compatibility.md
  3. 56
      docs/content/Packages.md
  4. 64
      docs/content/index.md
  5. 4
      docs/tools/templates/template.cshtml

2
MathNet.Numerics.sln

@ -36,6 +36,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{039229DA-AFDA-48DB-B7FC-B064691DEE96}" Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{039229DA-AFDA-48DB-B7FC-B064691DEE96}"
ProjectSection(SolutionItems) = preProject ProjectSection(SolutionItems) = preProject
docs\content\Build.md = docs\content\Build.md docs\content\Build.md = docs\content\Build.md
docs\content\Compatibility.md = docs\content\Compatibility.md
docs\content\CSV.fsx = docs\content\CSV.fsx docs\content\CSV.fsx = docs\content\CSV.fsx
docs\content\DescriptiveStatistics.fsx = docs\content\DescriptiveStatistics.fsx docs\content\DescriptiveStatistics.fsx = docs\content\DescriptiveStatistics.fsx
docs\content\Distance.fsx = docs\content\Distance.fsx docs\content\Distance.fsx = docs\content\Distance.fsx
@ -52,6 +53,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{039229DA-A
docs\content\Matrix.fsx = docs\content\Matrix.fsx docs\content\Matrix.fsx = docs\content\Matrix.fsx
docs\content\MatrixMarket.fsx = docs\content\MatrixMarket.fsx docs\content\MatrixMarket.fsx = docs\content\MatrixMarket.fsx
docs\content\MKL.md = docs\content\MKL.md docs\content\MKL.md = docs\content\MKL.md
docs\content\Packages.md = docs\content\Packages.md
docs\content\Probability.fsx = docs\content\Probability.fsx docs\content\Probability.fsx = docs\content\Probability.fsx
docs\content\Random.fsx = docs\content\Random.fsx docs\content\Random.fsx = docs\content\Random.fsx
docs\content\Regression.fsx = docs\content\Regression.fsx docs\content\Regression.fsx = docs\content\Regression.fsx

4
docs/content/Compatibility.md

@ -1,5 +1,5 @@
Platform Compatibility Platform Support
====================== ================
Supported Platforms: Supported Platforms:

56
docs/content/Packages.md

@ -0,0 +1,56 @@
NuGet Packages & Binaries
=========================
The recommended way to get Math.NET Numerics is NuGet. The following packages are
provided and maintained in the public [NuGet Gallery](https://nuget.org/profiles/mathnet/).
Some but not all releases are also available as Zip files on
[CodePlex Downloads](http://mathnetnumerics.codeplex.com/releases) or in the
[GitHub Releases](https://github.com/mathnet/mathnet-numerics/releases).
The complete set of Zip and NuGet packages including symbol packages is available in
[release archive](http://1drv.ms/1NlUeDT).
Math.NET Numerics
-----------------
In most scenarios you'll only need the primary package named `MathNet.Numerics`.
If you are working with F# we recommend to also use the F# extension package
for a more natural and idiomatic experience.
[MathNet.NET Numerics Release Notes](ReleaseNotes.html)
- [**MathNet.Numerics**](https://www.nuget.org/packages/MathNet.Numerics/) - core package, including .Net 4, .Net 3.5 and portable/PCL builds.
- [**MathNet.Numerics.FSharp**](https://www.nuget.org/packages/MathNet.Numerics.FSharp/) - optional extensions for a better F# experience. BigRational.
Both packages above do not have a strong name. While we do not recommend it,
there are valid scenarios where strong named assemblies are required. That's why
we also provide strong-named variants with the `.Signed` suffix. Note that signed
packages do not contain portable builds.
- [**MathNet.Numerics.Signed**](https://www.nuget.org/packages/MathNet.Numerics.Signed/) - strong-named version of the core package.
- [**MathNet.Numerics.FSharp.Signed**](https://www.nuget.org/packages/MathNet.Numerics.FSharp.Signed/) - strong-named version of the F# package.
Intel MKL Native Provider
-------------------------
Since v3.6.0 Math.NET Numerics can automatically choose the 64- or 32-bit version
of native providers depending on the operating system and process. But we do not
provide combined NuGet packages yet. If you intend to [maintain the native binaries
manually](MKL.html#Native-Binaries) it may be easier to download the combined Zip file in the release archive.
[Intel MKL Native Provider Release Notes](ReleaseNotes-MKL.html)
- [**MathNet.Numerics.MKL.Win-x64**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Win-x64/) - Windows 64-bit.
- [**MathNet.Numerics.MKL.Win-x86**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Win-x86/) - Windows 32-bit.
- [**MathNet.Numerics.MKL.Linux-x64**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Linux-x64/) - Linux 64-bit.
- [**MathNet.Numerics.MKL.Linux-x86**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Linux-x86/) - Linux 32-bit.
Data Extensions
---------------
Data/IO Packages for reading and writing data.
[Data Extensions Release Notes](ReleaseNotes-Data.html)
- [**MathNet.Numerics.Data.Text**](https://www.nuget.org/packages/MathNet.Numerics.Data.Text/) - Text-based matrix formats like [CSV](CSV.html) and [MatrixMarket](MatrixMarket.html).
- [**MathNet.Numerics.Data.Matlab**](https://www.nuget.org/packages/MathNet.Numerics.Data.Matlab/) - [MATLAB Level-5](MatlabFiles.html) matrix file format.

64
docs/content/index.fsx → docs/content/index.md

@ -1,9 +1,3 @@
(*** hide ***)
#I "../../out/lib/net40"
#r "MathNet.Numerics.dll"
#r "MathNet.Numerics.FSharp.dll"
(**
Math.NET Numerics Math.NET Numerics
================= =================
@ -22,54 +16,16 @@ optimization. Available for free under the [MIT/X11 License](License.html).
NuGet Packages NuGet Packages
-------------- --------------
The recommended way to get Math.NET Numerics is to use NuGet. The following - [**MathNet.Numerics**](https://www.nuget.org/packages/MathNet.Numerics/) - core package
packages are provided and maintained in the public - [**MathNet.Numerics.FSharp**](https://www.nuget.org/packages/MathNet.Numerics.FSharp/) - optional extensions for a better F# experience.
[NuGet Gallery](https://nuget.org/profiles/mathnet/).
Alternatively you can also download the binaries in Zip packages, available on
[CodePlex](http://mathnetnumerics.codeplex.com/releases).
Core Package:
- [**MathNet.Numerics**](https://www.nuget.org/packages/MathNet.Numerics/) - core package, including .Net 4, .Net 3.5 and portable/PCL builds.
- [**MathNet.Numerics.FSharp**](https://www.nuget.org/packages/MathNet.Numerics.FSharp/) - optional extensions for a better F# experience. BigRational.
- [**MathNet.Numerics.Signed**](https://www.nuget.org/packages/MathNet.Numerics.Signed/) - strong-named version of the core package *(not recommended)*.
- [**MathNet.Numerics.FSharp.Signed**](https://www.nuget.org/packages/MathNet.Numerics.FSharp.Signed/) - strong-named version of the F# package *(not recommended)*.
Alternative Provider Packages (optional):
- [**MathNet.Numerics.MKL.Win-x86**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Win-x86/) - Native Intel MKL Linear Algebra provider (Windows/32-bit).
- [**MathNet.Numerics.MKL.Win-x64**](https://www.nuget.org/packages/MathNet.Numerics.MKL.Win-x64/) - Native Intel MKL Linear Algebra provider (Windows/64-bit).
Data/IO Packages for reading and writing data (optional):
- [**MathNet.Numerics.Data.Text**](https://www.nuget.org/packages/MathNet.Numerics.Data.Text/) - Text-based matrix formats like CSV and MatrixMarket.
- [**MathNet.Numerics.Data.Matlab**](https://www.nuget.org/packages/MathNet.Numerics.Data.Matlab/) - MATLAB Level-5 matrix file format.
Platform Support and Dependencies The packages support .Net 4.0, .Net 3.5 and Mono on Windows, Linux and Mac,
--------------------------------- as well as PCL Portable Profiles 7, 47, 78, 259 and 328 for Windows 8, Silverlight 5,
Windows Phone/SL 8, Windows Phone 8.1.
- .Net 4.0, .Net 3.5 and Mono: Windows, Linux and Mac.
- PCL Portable Profiles 7, 47, 78, 259 and 328: Windows 8, Silverlight 5, Windows Phone/SL 8, Windows Phone 8.1.
- Xamarin: Android, iOS
The F# extensions support a slightly reduced platform set:
- .Net 4.0, .Net 3.5 and Mono: Windows, Linux and Mac.
- PCL Portable Profile 47: Windows 8, Silverlight 5
- Xamarin: Android, iOS
Package Dependencies:
- .Net 4.0 and higher, Mono, PCL Profiles: None
- .Net 3.5: [Task Parallel Library for .NET 3.5](http://www.nuget.org/packages/TaskParallelLibrary)
- F# on .Net 4.0 an higher, Mono, PCL Profiles: additionally [FSharp.Core](http://www.nuget.org/packages/FSharp.Core)
Framework Dependencies (part of the .NET Framework):
- .Net 4.0 and higher, Mono, PCL profiles 7 and 47: System.Numerics
- .Net 3.5, PCL profiles 78, 259 and 328: None
See [NuGet & Binaries](Packages.html) for a complete list of our NuGet packages,
Zip files and the release archive, and [Platform Support](Compatibility.html)
for details on what platforms are supported and how their limitations are handled.
Using Math.NET Numerics with C# Using Math.NET Numerics with C#
------------------------------- -------------------------------
@ -112,6 +68,8 @@ immediately and print the result to the output. Use the tab key for auto-complet
For convenience our F# packages include a small script that sets everything up properly: For convenience our F# packages include a small script that sets everything up properly:
[lang=fsharp] [lang=fsharp]
// this load statement is only needed in F# interactive,
// in a compiled F# project you'd use normal .Net assembly references.
#load "../packages/MathNet.Numerics.FSharp.3.0.0/MathNet.Numerics.fsx" #load "../packages/MathNet.Numerics.FSharp.3.0.0/MathNet.Numerics.fsx"
open MathNet.Numerics open MathNet.Numerics
@ -214,5 +172,3 @@ Which will print something like the following to the output:
-2.01044 4.06481 -0.128382 0.51167 -1.70276 ... -2.01044 4.06481 -0.128382 0.51167 -1.70276 ...
See [Intel MKL](MKL.html) for details how to use native providers on Linux. See [Intel MKL](MKL.html) for details how to use native providers on Linux.
*)

4
docs/tools/templates/template.cshtml

@ -62,11 +62,11 @@
<ul class="nav nav-list" id="menu"> <ul class="nav nav-list" id="menu">
<li class="nav-header">Math.NET Numerics</li> <li class="nav-header">Math.NET Numerics</li>
<li><a href="http://numerics.mathdotnet.com">Project Website</a></li> <li><a href="@Root/Packages.html">NuGet & Binaries</a></li>
<li><a href="@Root/ReleaseNotes.html">Release Notes</a></li> <li><a href="@Root/ReleaseNotes.html">Release Notes</a></li>
<li><a href="@Root/License.html">MIT/X11 License</a></li> <li><a href="@Root/License.html">MIT/X11 License</a></li>
<li><a href="@Root/Compatibility.html">Platform Support</a></li>
<li><a href="http://numerics.mathdotnet.com/api/">Class Reference</a></li> <li><a href="http://numerics.mathdotnet.com/api/">Class Reference</a></li>
<li><a href="@Root/Compatibility.html">Platform Compatibility</a></li>
<li><a href="https://github.com/mathnet/mathnet-numerics/issues">Issues & Bugs</a></li> <li><a href="https://github.com/mathnet/mathnet-numerics/issues">Issues & Bugs</a></li>
<li><a href="@Root/Users.html">Who is using Math.NET?</a></li> <li><a href="@Root/Users.html">Who is using Math.NET?</a></li>

Loading…
Cancel
Save