Skip to content

Commit

Permalink
Update README.md and pre-commit workflow (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
spencerkclark authored Apr 30, 2023
1 parent af1d715 commit 85ff3ae
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/pre-commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ jobs:
name: "pre-commit hooks"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: pre-commit/action@v2.0.3
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: pre-commit/action@v3.0.0
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repos:
rev: 22.6.0
hooks:
- id: black
- repo: https://gitlab.com/pycqa/flake8
- repo: https://github.com/PyCQA/flake8.git
rev: 4.0.1
hooks:
- id: flake8
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,13 @@ import xpartition

from external import construct_lazy_dataset

parser = argparse.ArgumentParser(
prog="initialize_store",
description="initialize a zarr store for a dataset"
)
parser.add_argument("store", help="absolute path to directory to store zarr result")

args = parser.parse_args()
ds = construct_lazy_dataset()
ds.partition.initialize_store(args.store)
```
Expand All @@ -49,7 +55,10 @@ import xpartition

from external import construct_lazy_dataset


parser = argparse.ArgumentParser(
prog="write_partition",
description="write a partition of a dataset"
)
parser.add_argument("store", help="absolute path to directory to store zarr result")
parser.add_argument("ranks", type=int, help="total number of available ranks")
parser.add_argument("rank", type=int, help="rank of job")
Expand Down

0 comments on commit 85ff3ae

Please sign in to comment.