Skip to content

Commit 3de2b3d

Browse files
authored
Update README with package descriptions
Added details about the repository structure and packages.
1 parent c30d100 commit 3de2b3d

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ A prototype demonstrating how to implement configurable fixes
33

44
## Layout
55

6+
For demonstration purposes, this repository contains three Python packages, but the idea would be that these would live in separate repositories later on:
7+
68
- [packages/fixer](packages/fixer) The package that users will import. It provides a single function `fix` that takes an xarray dataset
79
and the dataset name and returns a correctly standardized dataset based on the available configuration. It also provides the infrastructure
810
needed by plugins and widely applicable functions for fixing data in [`fixer.fixes`](packages/fixer/fixer/fixes.py).

0 commit comments

Comments
 (0)