LiPD Utilities

Input/output and manipulation utilities for LiPD files in Matlab, R and Python

About the Project

Community

LiPD

Input/output and manipulation utilities for LiPD files in Matlab, R and Python.

What is it?

LiPD is short for Linked PaleoData. LiPD files are the data standard for storing and exchanging data amongst paleoclimate scientists. The package will help you convert your existing paleoclimate observations into LiPD files that can be shared and analyzed.

Organizing and using your observation data can be time consuming. Our goal is to let you focus on more important tasks than data wrangling.

Installation

Python:

Python v3.4+ is required

pip install LiPD

R:

'devtools package' is required

devtools::install_github("nickmckay/LiPD-Utilities", subdir = "R")

Matlab:

Use the "Clone or download" button on the Github repository page to get a copy of the LiPD Utilities code on your computer. Note where the code is saved, and add the the path in you Matlab search paths.

Usage

The functions below are considered the core functions of the LiPD package. These functions are consistent across the 3 languages. There may be some slight differences in calling the functions, but the names, parameters and returned data is the same.

readLipd(path="")
writeLipd(data, path="")
extractTs(data, chron=False)
collapseTs(timeseries)
filterTs(timeseries, expression)
queryTs(timeseries, expression)

Language-specific Documentation

The core functions are consistent across the 3 languages; However, each language has some nuances that you may be unfamiliar with. For example, in Python you may call 'lipd.readLipd()', whereas in R you may call the same function with 'lipd::readLipd()' or 'readLipd()'. Not only that, but we have included additional functions in Python that you may be interested in. The language-specific documentation linked below will go into detail about all the functions included in each language.

Python Docs
R Docs
Matlab Docs

Features

Example Files

Examples Folder

The examples folder contains blank templates and example files. Use the blank templates to insert your own data for conversion, or test out the package using some of the example files.

You'll also find a set of Jupyter Notebooks in the examples folder. Notebooks are an instructional tool to show examples of python code and code output. Use these Notebooks as a guide to getting familiar with LiPD and its functions.

Jupyter is not required to use the LiPD package.

Requirements

Please refer to the requirements file

Further information

Github - LiPD-utilities
Github - GeoChronR
Linked Earth Wiki
Jupyter Documentation


Contact

If you are having issues, please let me know at heiser@nau.edu.

License

The project is licensed under the GNU Public License.

Hosted on GitHub Pages — Theme by orderedlist