joeroe/ruby-radiocarbon

Ruby gem for fast radiocarbon calibration

ruby-radiocarbon

A Ruby gem for fast radiocarbon calibration.

Full documentation can be found at RubyDoc.

Installation

Install the latest release from RubyGems:

gem install radiocarbon

Or by add it to your project's Gemfile:

gem 'radiocarbon', '~> 0.1.0'

Usage

As a Ruby library:

# Returns a calibrated radiocarbon date
c14_date = Radiocarbon::C14Date.new(age = 10000, error = 30)
cal_date = c14_date.calibrate()

# Returns the probability distribution of a calibrated date over the full
# range of the calibration curve
cal_date.pdist

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

ruby-radiocarbon's Issues

Add more calibration curves

• IntCal20
• SHCal20
• Marine20
• IntCal13
• SHCal13
• Marine13
• IntCal09
• Marine09
• IntCal04
• SHCal04
• Marine04
• IntCal98
• Marine98

Improve test coverage

Add RDoc/YARD documentation

Support post-bomb calibration

Add command line interface

Extract HDI from a CalDate

Convert between CRA and F14C

See https://c14.joeroe.io/reference/c14_units.html

Extract probability distribution from a CalDate over a given range of years

Extract point estimates from a CalDate

See https://c14.joeroe.io/reference/cal_point.html

Support custom calibration curves

Incl. reading from a .14c or .f14c file, see: https://c14.joeroe.io/reference/read_14c.html