Skip to content

Commit 41b2610

Browse files
update README.md with improved text and a pseudo-example
1 parent 47b21d0 commit 41b2610

1 file changed

Lines changed: 57 additions & 17 deletions

File tree

README.md

Lines changed: 57 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img alt="batchee, a python package for grouping together filenames to enable subsequent batched operations (such as concatenation)."
2+
<img alt="Batchee logo"
33
src="https://github.com/danielfromearth/batchee/assets/114174502/8b1a92a5-eccc-4674-9c00-3698e752077e" width="250"
44
/>
55
</p>
@@ -15,7 +15,7 @@
1515
<img src="https://img.shields.io/pypi/pyversions/batchee.svg" alt="Python Versions">
1616
</a>
1717
<a href="https://pypi.org/project/batchee" target="_blank">
18-
<img src="https://img.shields.io/pypi/v/batchee?color=%2334D058label=pypi%20package" alt="Package version">
18+
<img src="https://img.shields.io/pypi/v/batchee?color=%2334D058&label=pypi%20package" alt="Package version">
1919
</a>
2020
<a href="https://codecov.io/gh/nasa/batchee">
2121
<img src="https://codecov.io/gh/nasa/batchee/graph/badge.svg?token=WDj92iN7c4" alt="Code coverage">
@@ -26,42 +26,82 @@
2626

2727

2828
# Overview
29-
_____
3029

31-
_Batchee_ groups together filenames so that further operations (such as concatenation) can be performed separately on each group of files.
30+
**Batchee** is a Python package that intelligently groups filenames together, enabling efficient batch operations like concatenation.
3231

33-
## Installing
34-
_____
32+
### What does it do?
3533

36-
For local development, one can clone the repository and then use poetry or pip from the local directory:
34+
Batchee analyzes filename patterns and groups related files together.
35+
For example (_note that these are pseudo-real, not actual, TEMPO file names_):
36+
37+
```shell
38+
batchee TEMPO_NO2_L2_S006G01.nc TEMPO_NO2_L2_S006G02.nc TEMPO_NO2_L2_S007G08.nc TEMPO_NO2_L2_S007G09.nc
39+
```
40+
41+
**Output:**
42+
- `TEMPO_NO2_L2_S006G01.nc`, `TEMPO_NO2_L2_S006G02.nc` → Group 1 (scan 6)
43+
- `TEMPO_NO2_L2_S007G08.nc`, `TEMPO_NO2_L2_S007G09.nc` → Group 2 (scan 7)
44+
45+
This enables batch processing operations on each group separately.
46+
47+
### Key Features
48+
- Automatic filename grouping based on configurable patterns
49+
- Command-line interface and Python API for integration with NASA Harmony service orchestrator
50+
- Verbose logging for debugging
51+
52+
## Installation
53+
54+
### From PyPI (Recommended)
55+
```shell
56+
pip install batchee
57+
```
58+
59+
### From Source (Development)
60+
61+
For local development or the latest features:
3762

3863
```shell
3964
git clone <Repository URL>
65+
cd batchee
4066
```
4167

42-
###### (Option A) using poetry:
43-
i) Follow the instructions for installing `poetry` [here](https://python-poetry.org/docs/).
68+
**(Option A) using poetry (Recommended for development):**
69+
70+
```shell
71+
# Install poetry: https://python-poetry.org/docs/
72+
poetry install
73+
```
4474

45-
ii) Run ```poetry install``` from the repository directory.
75+
**(Option B) using pip:**
4676

47-
###### (Option B) using pip: Run ```pip install .``` from the repository directory.
77+
```shell
78+
pip install .
79+
```
4880

4981
## Usage
50-
_____
82+
83+
### Basic Usage
5184

5285
```shell
5386
batchee [file_names ...]
5487
```
5588

56-
###### Or, If installed using a `poetry` environment:
89+
### With Poetry (if installed via poetry)
5790
```shell
5891
poetry run batchee [file_names ...]
5992
```
6093

61-
#### Options
94+
### Options
95+
96+
- **`-h, --help`** - Show help message and exit
97+
- **`-v, --verbose`** - Enable verbose output to stdout; useful for debugging
98+
99+
## Contributing
100+
101+
Issues and pull requests welcome on [GitHub](https://github.com/nasa/batchee/).
102+
103+
## License & Attribution
62104

63-
- `-h`, `--help` show this help message and exit
64-
- `-v`, `--verbose` Enable verbose output to stdout; useful for debugging
105+
Batchee is released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
65106

66-
---
67107
This package is NASA Software Release Authorization (SRA) # LAR-20440-1

0 commit comments

Comments
 (0)