Skip to content

Commit 404ed8f

Browse files
committed
Add V1 state reference material
1 parent 0ba83e9 commit 404ed8f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

v1.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Current state:
2+
- The reference branch is forked from an [un-merged PR](https://github.com/TGSAI/mdio-python/pull/553) which slightly updates the Coordinates model.
3+
- We have [reference implementation](https://github.com/BrianMichell/mdio-python/tree/v1_ingestion_YOLO) for:
4+
- [Builder pattern](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/src/mdio/core/v1/builder.py), [Internal serialization](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/src/mdio/core/v1/_serializer.py), [Unit test](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/tests/unit/schema/v1/test_template_builder.py)
5+
- [Limited factory](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/src/mdio/core/v1/factory.py), [Unit test](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/tests/unit/test_template_factory.py)
6+
- [JSON schema](https://github.com/BrianMichell/mdio-python/tree/v1_ingestion_YOLO/src/mdio/schemas)
7+
- Validation is [Unit tested](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/tests/unit/test_schema.py)
8+
9+
- [Xarray overloads](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/src/mdio/core/v1/_overloads.py)
10+
11+
- Schematized [SEGY ingestion](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLO/src/mdio/converters/segy.py#L639C22-L890)
12+
- Works for a single case, untested for more
13+
- No unit tests
14+
- Internal function calls required to be changed, several levels deep
15+
- Likely poor implementation
16+
- Questionable memory management and native threading
17+
18+
- [SEGY export](https://github.com/BrianMichell/mdio-python/blob/v1_ingestion_YOLOsrc/mdio/converters/mdio.py#L29-L190)
19+
- Works for a single case, untested for more
20+
- No unit tests
21+
- Breaks v0.X compatibility (unit tests invalidated)
22+
- Internal function calls required to be changed, several levels deep
23+
- Requires MDIO file to come from ingestion (have all expected fields)
24+
- Only need to worry about the MDIO input, SEGY output should all be fine.
25+
26+
27+
- What would be nice to have:
28+
- Native parallelism for MDIO I/O
29+
- Zarr v3 engine (added in 0.9) enables native parallelism, reducing need tomanage spawned processes.
30+
- I have not yet tested if this holds true for the Xarray implementation for MDIO v1.0
31+
32+
- Better memory utilization
33+
- The reference branch borrows from an un-merged PR which seeks to reduce overall memory consumption wherever possible due to [OOM issues](https://github.com/TGSAI/mdio-python/pull/558).

0 commit comments

Comments
 (0)