Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ This repository contains DFODE-kit, a Python toolkit for sampling combustion sta

## Structure
- `dfode_kit/cli/`: CLI entrypoints and subcommands
- `dfode_kit/data_operations/`: dataset I/O, labeling, augmentation, integration utilities
- `dfode_kit/dfode_core/`: models, training, preprocessing
- `dfode_kit/df_interface/`: DeepFlame/OpenFOAM-facing helpers
- `dfode_kit/cases/`: case init, presets, sampling, and DeepFlame/OpenFOAM-facing helpers
- `dfode_kit/data/`: data contracts, HDF5 I/O, and integration helpers
- `dfode_kit/data_operations/`: labeling and augmentation workflows
- `dfode_kit/models/`: model architectures and registries
- `dfode_kit/training/`: training configuration, loops, and preprocessing
- `docs/agents/`: deeper agent-facing docs and workflow conventions
- `tests/`: lightweight harness tests; keep them fast

Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,12 @@ If you are working on the repository itself, see:

## Repository layout

- `dfode_kit/cli/` — canonical CLI entrypoints and subcommands
- `dfode_kit/cli_tools/` — legacy compatibility shims for older CLI import paths
- `dfode_kit/cases/` — canonical case init/preset/sampling boundaries for DeepFlame/OpenFOAM workflows
- `dfode_kit/df_interface/` — legacy compatibility shims for case-facing helpers during the cases migration
- `dfode_kit/data/` — emerging canonical package for data contracts and HDF5 I/O helpers
- `dfode_kit/data_operations/` — legacy and transitional dataset I/O, augmentation, labeling, and integration helpers
- `dfode_kit/models/` — canonical model package
- `dfode_kit/training/` — canonical training package
- `dfode_kit/dfode_core/` — legacy compatibility surface for model/training code during migration
- `dfode_kit/cli/` — CLI entrypoints and subcommands
- `dfode_kit/cases/` — case init, presets, sampling, and DeepFlame/OpenFOAM-facing helpers
- `dfode_kit/data/` — data contracts, HDF5 I/O, and integration helpers
- `dfode_kit/data_operations/` — augmentation and labeling workflows
- `dfode_kit/models/` — model architectures and registries
- `dfode_kit/training/` — training configuration, registries, training loops, and preprocessing
- `canonical_cases/` — canonical flame case templates
- `tutorials/` — tutorial notebooks and workflow examples
- `docs/` — published project documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"import numpy as np\n",
"import matplotlib.pyplot as plt\n",
"\n",
"from dfode_kit.df_interface import (\n",
"from dfode_kit.cases import (\n",
" OneDFreelyPropagatingFlameConfig,\n",
" setup_one_d_flame_case,\n",
" df_to_h5,\n",
Expand All @@ -32,7 +32,7 @@
" label_npy,\n",
" integrate_h5,\n",
")\n",
"from dfode_kit.dfode_core.model.mlp import MLP\n",
"from dfode_kit.models.mlp import MLP\n",
"from dfode_kit.utils import BCT\n",
"\n",
"DFODE_ROOT = os.environ['DFODE_ROOT']"
Expand Down
3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/__init__.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/command_loader.py

This file was deleted.

1 change: 0 additions & 1 deletion dfode_kit/cli_tools/commands/__init__.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/augment.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/config.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/h52npy.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/init.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/init_helpers.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/label.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/run_case.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/run_case_helpers.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/sample.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/cli_tools/commands/train.py

This file was deleted.

7 changes: 0 additions & 7 deletions dfode_kit/cli_tools/main.py

This file was deleted.

31 changes: 0 additions & 31 deletions dfode_kit/df_interface/__init__.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/df_interface/case_init.py

This file was deleted.

4 changes: 0 additions & 4 deletions dfode_kit/df_interface/flame_configurations.py

This file was deleted.

3 changes: 0 additions & 3 deletions dfode_kit/df_interface/oneDflame_setup.py

This file was deleted.

4 changes: 0 additions & 4 deletions dfode_kit/df_interface/sample_case.py

This file was deleted.

Empty file removed dfode_kit/dfode_core/__init__.py
Empty file.
33 changes: 0 additions & 33 deletions dfode_kit/dfode_core/model/__init__.py

This file was deleted.

5 changes: 0 additions & 5 deletions dfode_kit/dfode_core/model/mlp.py

This file was deleted.

10 changes: 0 additions & 10 deletions dfode_kit/dfode_core/model/registry.py

This file was deleted.

43 changes: 0 additions & 43 deletions dfode_kit/dfode_core/train/__init__.py

This file was deleted.

19 changes: 0 additions & 19 deletions dfode_kit/dfode_core/train/config.py

This file was deleted.

5 changes: 0 additions & 5 deletions dfode_kit/dfode_core/train/formation.py

This file was deleted.

10 changes: 0 additions & 10 deletions dfode_kit/dfode_core/train/registry.py

This file was deleted.

8 changes: 0 additions & 8 deletions dfode_kit/dfode_core/train/supervised_physics.py

This file was deleted.

5 changes: 0 additions & 5 deletions dfode_kit/dfode_core/train/train.py

This file was deleted.

1 change: 0 additions & 1 deletion dfode_kit/runtime_config.py

This file was deleted.

2 changes: 2 additions & 0 deletions dfode_kit/training/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"get_trainer_factory",
"register_trainer",
"registered_trainers",
"DataPreprocessor",
"train",
]

Expand All @@ -28,6 +29,7 @@
"get_trainer_factory": ("dfode_kit.training.registry", "get_trainer_factory"),
"register_trainer": ("dfode_kit.training.registry", "register_trainer"),
"registered_trainers": ("dfode_kit.training.registry", "registered_trainers"),
"DataPreprocessor": ("dfode_kit.training.preprocess", "DataPreprocessor"),
"train": ("dfode_kit.training.train", "train"),
}

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/agents/train-config-plan.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Training/config refactor plan

## Scope
Keep changes tightly limited to the model/training package boundary (`dfode_kit/models`, `dfode_kit/training`, plus compatibility shims under `dfode_kit/dfode_core/{model,train}`) and the train CLI surface needed to select registered components. Do not redesign data loading, labeling, or DeepFlame integration in this slice.
Keep changes tightly limited to the canonical model/training package boundary (`dfode_kit/models`, `dfode_kit/training`) and the train CLI surface needed to select registered components. Do not redesign data loading, labeling, or DeepFlame integration in this slice.

## Current audit
- `dfode_kit/training/train.py` hard-codes:
Expand Down
9 changes: 5 additions & 4 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
## Current repository structure

- `dfode_kit/cli/`: CLI entrypoints and subcommands
- `dfode_kit/data_operations/`: dataset I/O, contracts, labeling, augmentation, integration utilities
- `dfode_kit/dfode_core/`: models, training, registries, preprocessing
- `dfode_kit/cases/`: explicit case init, preset, sampling, and DeepFlame-facing helpers
- `dfode_kit/df_interface/`: compatibility layer for the legacy case-facing import paths
- `dfode_kit/cases/`: explicit case init, presets, sampling, and DeepFlame-facing helpers
- `dfode_kit/data/`: contracts, HDF5 I/O, and integration utilities
- `dfode_kit/data_operations/`: augmentation and labeling workflows
- `dfode_kit/models/`: model architectures and registries
- `dfode_kit/training/`: training configuration, training loops, registries, and preprocessing
- `docs/agents/`: agent-facing operational and planning docs
- `tests/`: lightweight repository and harness tests

Expand Down
2 changes: 0 additions & 2 deletions docs/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ This preset preserves the current hardcoded empirical logic from:
- `dfode_kit/cases/presets.py`
- method: `OneDFreelyPropagatingFlameConfig.update_config()`

Legacy `dfode_kit/df_interface/*` imports remain as compatibility shims during the package-topology migration.

## Stable intent

The command is a **preset instantiator**, not a claim of universal best practice.
Expand Down
2 changes: 1 addition & 1 deletion docs/run-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ DFODE-kit provides two CLI entrypoints for running DeepFlame/OpenFOAM cases repr

This document is the shared reference for both humans and AI agents.

Implementation note: runtime config helpers now live under `dfode_kit.runtime.config`, and reusable run planning/execution helpers live under `dfode_kit.runtime.run_case`. The legacy import paths remain as compatibility shims during migration.
Implementation note: runtime config helpers live under `dfode_kit.runtime.config`, and reusable run planning/execution helpers live under `dfode_kit.runtime.run_case`.

## Why a persistent runtime config exists

Expand Down
7 changes: 3 additions & 4 deletions tests/test_cases_shims.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
from dfode_kit.cases import init as cases_init
from dfode_kit.df_interface import case_init as legacy_case_init


def test_df_interface_case_init_reexports_cases_symbols():
assert legacy_case_init.resolve_oxidizer is cases_init.resolve_oxidizer
assert legacy_case_init.DEFAULT_ONE_D_FLAME_PRESET == cases_init.DEFAULT_ONE_D_FLAME_PRESET
def test_cases_init_exports_expected_symbols():
assert callable(cases_init.resolve_oxidizer)
assert cases_init.DEFAULT_ONE_D_FLAME_PRESET == "premixed-defaults-v1"
7 changes: 3 additions & 4 deletions tests/test_cli_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,8 @@ def test_main_returns_two_for_missing_handler(monkeypatch, capsys):
assert "Unknown command: dummy" in captured.err


def test_cli_tools_command_loader_shim_re_exports_cli_symbols():
shim = import_module("dfode_kit.cli_tools.command_loader")
def test_cli_command_loader_module_is_importable():
direct = import_module("dfode_kit.cli.command_loader")

assert shim.load_command_specs is direct.load_command_specs
assert shim.load_command is direct.load_command
assert callable(direct.load_command_specs)
assert callable(direct.load_command)
Loading
Loading