diff --git a/README.md b/README.md index eaca6a6..9836dec 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# ecflux \ No newline at end of file +# ecflux +This repository contains code for working with data from eddy covariance towers, with specific existing framework for working with data from Campbell Scientific loggers, EddyPro, and the [AmeriFlux network](https://ameriflux.lbl.gov). It includes modules for calculating flux tower footprints according to [Kljun et al. (2015)](https://footprint.kljun.net). + +## Getting Started +This code is a work in progress. For now, it can be used locally by cloning the repo. +##### Prerequisites +- `numpy` +- `pandas` +- `pytz` +- `timezonefinder` + +##### Installation +1. Clone the repo +``` +git clone https://github.com/brynemorgan/ecflux.git +``` + +## Contact +Bryn Morgan, [brynmorgan@ucsb.edu](mailto:brynmorgan@ucsb.edu)