Skip to content

Commit

Permalink
fill in the packaging metadata (#50)
Browse files Browse the repository at this point in the history
* add a description to the package file

* add a readme and use it as the long description

* add a repository link
  • Loading branch information
keewis committed Aug 25, 2023
1 parent 9c2f87a commit 53f5566
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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})
```
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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"
Expand Down

0 comments on commit 53f5566

Please sign in to comment.