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

Install globally on your system with:

pip install LiPD

Python v3.4+ is required

Usage

Using your preferred Python IDE or a Python console, you can import the LiPD package using:

import lipd

This import will trigger a prompt asking you to choose a source directory containing files.

Now, you can call any function in the LiPD package, but here are a few that are most useful to start with:

lipd.readLipds()
lipd.writeLipds()
lipd.validate()
lipd.excel()
lipd.noaa()

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