Skip to content

AndrewIOM/bristlecone

Repository files navigation

Bristlecone logo


NuGet Downloads GitHub Actions Workflow Status

An F# library for model-fitting model-selection (MFMS) of time-series models to observational data. Included is expressive modelling system for authoring models, which includes full F# units of measure support.

Bristlecone contains specialist functionality for fitting (long-term) ecological models. The library was developed for use in dendroecology and palaeoecology, but can be used for other time-series modelling problems.


NuGet

Package Stable Prerelease
Bristlecone NuGet Version NuGet Version
Bristlecone.Dendro NuGet Version NuGet Version

Getting Started

Bristlecone logo

To get started with Bristlecone, see the documentation website with tutorials, examples and API specification.

Some examples are provided on the docs page, with optional downloadable worked notebooks.

Benchmarks

A suite of benchmarks - covering optimisation methods and ecological time-series models - are included in the test/Bristlecone.Benchmark project. The most recent results of the benchmark tests are here.

Developers: Build Instructions

Bristlecone requires the .NET 10 SDK, and uses FAKE for building, testing, documentation, and publishing.

Simple building and testing can be done using dotnet build or dotnet run test/Bristlecone.Tests/Bristlecone.Tests.fsproj respectively in the root directory. Docs can be tested by first calling dotnet tool restore then dotnet fsdocs watch --eval, which serves them on a Suave server.

The full build process can be run using either dotnet fsi build.fsx, which uses FAKE to run all build steps, tests, and compile docs.

Contribute

Contributions, issues, and pull-requests are welcome.

Logo based on Free Vector Art by www.vecteezy.com

About

An F# library for mechanistic modelling of ecological time series data

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages