https://github.com/brews/carbonferret

A Python package to quickly fetch carbon reservoir records at the Marine Reservoir Correction database (http://calib.org/marine/).
https://github.com/brews/carbonferret

carbon chemistry marine paleoceanography paleoclimate python sediment

Last synced: 4 months ago
JSON representation

A Python package to quickly fetch carbon reservoir records at the Marine Reservoir Correction database (http://calib.org/marine/).

• Host: GitHub
• URL: https://github.com/brews/carbonferret
• Owner: brews
• License: gpl-3.0
• Created: 2017-05-30T18:14:40.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-09-17T23:25:25.000Z (over 7 years ago)
• Last Synced: 2026-01-04T13:52:45.250Z (5 months ago)
• Topics: carbon, chemistry, marine, paleoceanography, paleoclimate, python, sediment
• Language: HTML
• Homepage:
• Size: 34.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# carbonferret

[![Travis-CI Build Status](https://travis-ci.org/brews/carbonferret.svg?branch=master)](https://travis-ci.org/brews/carbonferret)

A Python package to quickly fetch carbon reservoir records at the Marine Reservoir Correction database (http://calib.org/marine/).

## Example

The carbonferret package is simple, but powerful. For instance, let's say we want to find two sediment records 

nearest 0° latitude, 0° longitude. We can open a python session and run:

    import carbonferret as cf

    

    results = cf.find_near(lat=0, lon=0, n=2)

The variable `results` is a [pandas](http://pandas.pydata.org/) DataFrame with information on sample location and 

reservoir values, among other variables provided by the Marine Reservoir Correction database.

We can take advantage of this. For example, we could find the average ΔR of these sites.

    results['DeltaR'].mean()

Of course there are several other variables that we can look at, such as site references or site location.

This can be useful if you want to look up a few quick numbers in the lab, or if you're writing a script to 

analyze hundreds of marine sediment cores.

## Installation

You can install the package [from PyPI](https://pypi.python.org/pypi/carbonferret) with

    pip install carbonferret

## Development and Support

Source code is [hosted online](https://github.com/brews/carbonferret) under an Open Source license. Please feel free to 

file any [bugs and issues](https://github.com/brews/carbonferret/issues) you find.