Metadata-Version: 2.4
Name: sliderule
Version: 5.6.1
Summary: SlideRule Python Client
License-Expression: BSD-3-Clause
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: numpy
Requires-Dist: geopandas
Requires-Dist: shapely
Requires-Dist: pyarrow
Dynamic: license-file

# sliderule python client

SlideRule's Python client makes it easier to interact with SlideRule from a Python script.

Detailed [documentation](https://docs.slideruleearth.io/) on installing and using this client can be found at [slideruleearth.io](https://slideruleearth.io/).

## I. Installing the SlideRule Python Client

```bash
conda install -c conda-forge sliderule
```

Basic functionality of sliderule-python depends on `requests`, `numpy`, and `geopandas`.  See [requirements.txt](requirements.txt) for a full list of the requirements.

## II. Example Usage

```python
# import
from sliderule import sliderule, icesat2

# initialize
sliderule.init(verbose=False)

# region of interest
region = [ {"lon":-105.82971551223244, "lat": 39.81983728534918},
           {"lon":-105.30742121965137, "lat": 39.81983728534918},
           {"lon":-105.30742121965137, "lat": 40.164048017973755},
           {"lon":-105.82971551223244, "lat": 40.164048017973755},
           {"lon":-105.82971551223244, "lat": 39.81983728534918} ]

# request parameters
parms = {
    "poly": region,
    "srt": icesat2.SRT_LAND,
    "cnf": icesat2.CNF_SURFACE_HIGH,
    "len": 40.0,
    "res": 20.0,
    "fit": {}
}

# make request
gdf = sliderule.run("atl03x", parms)
```

## III. Reference and User's Guide

Please see our [documentation](https://docs.slideruleearth.io/) page for reference and user's guide material.
