Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 3.09 KB

File metadata and controls

46 lines (31 loc) · 3.09 KB

mzLib

A library for mass spectrometry projects.

Release Build and Test codecov Coverity Scan Build Status

Github All Releases

image

NuGet packages are released here: https://www.nuget.org/packages/mzLib/

GitHub release tags are recoreded here: https://github.com/smith-chem-wisc/mzLib/releases

Documentation

The mzLib wiki is the usage documentation, and it is kept current. Among other things it covers:

The package also ships XML documentation, so mzLib types and members have tooltips in your IDE.

Usage examples used to live in this file. They were removed rather than rewritten because they had drifted out of date - one called a ProteinDatabaseLoader type that no longer exists - and a second copy of the documentation is a second thing to keep current. The wiki is the single place now.

Contributing

Tests live in mzLib/Test. Run them with dotnet test mzLib/Test/Test.csproj --filter "Category!=ExternalService"; the ExternalService category covers tests that reach live services such as UniProt, and is deliberately kept out of the required build so that an outage elsewhere cannot fail a pull request.

License

Code heavily borrowed from https://github.com/dbaileychess/CSMSL and distributed under the appropriate license, LGPL.

mzLib additionally redistributes third-party data files and native libraries whose licences are separate from its own; see THIRD-PARTY-NOTICES.md.