diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ab0b83 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# xarray-ceos-alos2 + +Read ALOS2 CEOS files into `datatree` objects. + +## Installation + +From PyPI + +```sh +pip install xarray-ceos-alos2 +``` + +From conda-forge + +```sh +conda install -c conda-forge xarray-ceos-alos2 +``` + +## Usage + +```python +import ceos_alos2 + +tree = ceos_alos2.open_alos2(url, chunks={}, backend_options={"requests_per_chunk": 4096}) +``` diff --git a/pyproject.toml b/pyproject.toml index 2fdb31a..f4f624f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,6 +2,8 @@ name = "xarray-ceos-alos2" requires-python = ">= 3.10" license = {text = "MIT"} +description = "xarray reader for advanced land observing satellite 2 (ALOS2) CEOS files" +readme = "README.md" dependencies = [ "toolz", "python-dateutil", @@ -13,6 +15,9 @@ dependencies = [ ] dynamic = ["version"] +[project.urls] +repository = "https://github.com/umr-lops/xarray-ceos-alos2" + [build-system] requires = ["setuptools>=64.0", "setuptools-scm"] build-backend = "setuptools.build_meta"