Metadata-Version: 2.4
Name: dapper-elm
Version: 1.0
Summary: Data Preprocessing for ELM Runs
Author-email: Dapper contributors <dapper@lanl.gov>
License: ## COPYRIGHT
        
        *© 2025. Triad National Security, LLC. All rights reserved.*
        
        *This program was produced under U.S. Government contract 89233218CNA000001 for Los Alamos National Laboratory (LANL), which is operated by Triad National Security, LLC for the U.S. Department of Energy/National Nuclear Security Administration. All rights in the program are reserved by Triad National Security, LLC, and the U.S. Department of Energy/National Nuclear Security Administration. The Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this material to reproduce, prepare. derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.*
        
        ## LICENSE
        
        This program is Open-Source under the BSD-3 License.
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        
        - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
         
        
        - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
         
        
        Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        *THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.*
        
Project-URL: Homepage, https://github.com/NGEE-Arctic/dapper
Project-URL: Bug Tracker, https://github.com/NGEE-Arctic/dapper/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: license.md
Requires-Dist: geopandas
Requires-Dist: earthengine-api
Requires-Dist: geemap
Requires-Dist: pip
Requires-Dist: xarray
Requires-Dist: cftime
Requires-Dist: tqdm
Requires-Dist: rioxarray
Requires-Dist: jupyter
Requires-Dist: fastparquet
Requires-Dist: netcdf4
Requires-Dist: intake-esm
Requires-Dist: gcsfs
Dynamic: license-file

[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://ngee-arctic.github.io/dapper/)

<p align="center">
  <img src="docs/_static/images/dapper_logo_2.jpg" width="50%" alt="dapper">
</p>



## About
The E3SM Land Model (ELM) has become useful for a wide range of investigations across a broad array of scales--from single-site to global. Each ELM run requires a hefty set of data formatted in a particular way. Two of the required "types" of data are meteorological data (time series of "met forcings") and parameter files (customizable "surface file"). As ELM capability grows, the complexity of, for example, the surface files grows to accomodate new options and parameters. Additionally, met data is usually sampled at high temporal frequency (daily/subdaily). These data requirements place a large startup burden on (particularly new) users of ELM. 

DaPPER provides tools to alleviate these burdens to some degree. DaPPER relies on Google Earth Engine and other APIs to make sampling met data and surface file data fast, scalable to very large domains, and flexible to different "types" of grid cells (e.g. arbitrary polygons like watersheds instead of rectangular grids). DaPPER is being developed with the goals of NGEE-Arctic Crosscut 3 in mind, which focuses on scaling and resolution experiments. However, the broader vision is to develop a toolkit that is useful across the E3SM project, not just NGEE. We also hope that DaPPER can provide some documentation and clarity regarding the creation and use of these input data, which to-date seems to be lacking.

DaPPER is under development, which means that you should consider everything *beta* and subject to change daily. We try to alleviate this instability by maintaining a `dev` branch of the repo that can be very dynamic. The `main` branch is intended to be more stable. If you're not sure, just stick to the `main` repo.

DaPPER's "lead developer" is Jon Schwenk at LANL, but many contribute code, ideas, and review (see Contributors below).


## Getting started
Refer to the documentation [here](https://ngee-arctic.github.io/dapper/getting-started.html).

## Usage
We have created some [jupyter notebooks](https://github.com/NGEE-Arctic/dapper/tree/main/docs/notebooks) to demonstrate ways to use `dapper` tools.

## Contributing & Contact
Feel free to fork or branch the repo and make improvements. Open a pull request and we'll check it out. For suggestions and other general queations regarding `dapper`, email **dapper@lanl.gov**.

### Contributors

- [Jon Schwenk](https://github.com/jonschwenk)
- [Ryan Crumley](https://github.com/ryanlcrumley)
- [Rich Fiorella](https://github.com/rfiorella)
- [Cade Trotter](https://github.com/ctrotterlanl)
- [Jemma Stachelek](https://github.com/jsta)
- [Ross Spicer](https://github.com/rwspicer)
- [Maggie Farley](https://github.com/maggiefarley)

## Copyright/License
O4898 (for copyright verification); see the [License](https://github.com/NGEE-Arctic/dapper/tree/main/license.md) file.
