Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 3 KB

File metadata and controls

61 lines (48 loc) · 3 KB

Optional third-party comparisons

This project contains the EPPlus and NPOI benchmarks moved out of the default benchmark project. It inherits the regular benchmarks so a comparison run still measures MiniExcel and the other implementations on the same input and job. It is not included in the default benchmark solution or regular benchmark CI. Neither benchmark project is packable. Production packages do not reference either project. This independent repository is not included in MiniExcel's new source or binary releases; historical MiniExcel tags and archives are unchanged.

Licenses

The pinned NuGet packages declare the following licenses:

Package Version Package license
EPPlus 7.7.3 license.md: PolyForm Noncommercial 1.0.0; commercial use requires the appropriate commercial license
NPOI 2.8.0 OSMFEULA.txt: binary-release maintenance-fee EULA; the package also includes an Apache-2.0 LICENSE for source

Review the actual packages and the terms on EPPlus NuGet and NPOI NuGet before use. Comparison, testing, or ASF incubation does not automatically grant an exemption. The supplied EPPlus setup is for qualifying noncommercial use only; these instructions do not configure a commercial EPPlus license. Discuss the intended usage and ASF release contents with mentors during incubation.

Regular unit tests do not use these packages. They use ClosedXML 0.105.0 (MIT) and direct OpenXML checks instead; no downgrade to an old EPPlus/NPOI version is needed. This separation is not a full ASF license audit of other dependencies, fixtures, or distribution contents.

Running explicitly

Use the regular project for benchmarks without EPPlus/NPOI:

dotnet run --project benchmarks\MiniExcel.Benchmarks -c Release -f net10.0 -- --filter '*QueryExcelBenchmark.MiniExcel_Query'

Only after reviewing and accepting the applicable terms, and confirming that your EPPlus use qualifies as noncommercial, opt in explicitly:

$env:AcceptEPPlusNonCommercialLicense = 'true'
$env:AcceptNPOIOSMFLicense = 'true'
dotnet run --project benchmarks\MiniExcel.ComparisonBenchmarks -c Release -f net10.0 -- --filter '*QueryExcelComparisonBenchmark*'
Remove-Item Env:\AcceptEPPlusNonCommercialLicense
Remove-Item Env:\AcceptNPOIOSMFLicense

Environment variables are used so BenchmarkDotNet's generated build processes inherit the same explicit acknowledgements. Without both acknowledgements, restore/build fails with an explanatory error. Acknowledgements are not saved in the project. The project targets the same frameworks as the regular benchmarks; install the corresponding SDKs before restoring it.

To select creation comparisons, use '*CreateExcelComparisonBenchmark*'. To list registered methods without running measurements, pass --list flat. Run from the repository root; the referenced regular benchmark project copies the shared input workbooks to the output directory.