orcaflex-file-conversion

name	orcaflex-file-conversion
description	Convert OrcaFlex files between formats (.dat, .yml, .sim) for digital analysis and automation. Supports bidirectional conversion, batch processing, and format standardization.
type	reference
version	1.0.0
updated	"2026-01-02T00:00:00.000Z"
category	engineering
triggers	["convert OrcaFlex files",".dat to .yml conversion",".yml to .dat conversion",".sim to .dat conversion",".sim to .yml conversion","OrcaFlex file format conversion","batch OrcaFlex conversion","digitally analyze OrcaFlex files"]
capabilities	[]
requires	[]
tags	[]
scripts_exempt	true

Orcaflex File Conversion

When to Use

• Converting .dat files to .yml for human-readable inspection
• Converting .yml files back to .dat for OrcaFlex execution
• Converting .sim files to both .dat and .yml formats
• Batch processing multiple OrcaFlex files
• Preparing files for digital analysis and automation
• Creating version-control-friendly YAML representations
• Standardizing file formats across projects

Prerequisites

• OrcaFlex license (for OrcFxAPI)
• Python environment with digitalmodel package installed
• OrcFxAPI Python module configured

Quick Start

Single File Conversion

# Convert .dat to .yml
python -m digitalmodel.orcaflex.orcaflex_yml_converter model.dat

# Convert .yml to .dat
python -m digitalmodel.orcaflex.orcaflex_yml_converter model.yml

Batch Conversion

# Convert all .dat files in directory
python -m digitalmodel.orcaflex.examples_integration.batch_converter \
    --input-dir models/ \
    --output-dir models_yml/ \
    --pattern "*.dat"

# Convert with validation
python -m digitalmodel.orcaflex.examples_integration.batch_converter \
    --input-dir models/ \
    --output-dir models_yml/ \
    --validate \
    --max-retries 3

Python API

Basic Conversion

from digitalmodel.orcaflex.orcaflex_yml_converter import convert_to_yml
from pathlib import Path

# Convert single file
success = convert_to_yml("model.dat")

# Check output
if success:
    yml_file = Path("model.yml")
    print(f"Converted to: {yml_file}")

Batch Conversion with Progress Tracking

from digitalmodel.orcaflex.examples_integration.batch_converter import OrcaFlexBatchConverter
 pathlib  Path


converter = OrcaFlexBatchConverter(
    input_dir=Path(),
    output_dir=Path(),
    use_mock=,      
    validate=,       

*See sub-skills  full details.*


```python
 OrcFxAPI
 pathlib  Path

 ():
    
    yml_path = Path(yml_file)

    
     dat_file  :

*See sub-skills  full details.*


```python
 digitalmodel.orcaflex.examples_integration.orcfxapi_converter  OrcFxAPIConverter
 pathlib  Path


converter = OrcFxAPIConverter(
    input_dir=Path(),
    preserve_originals=
)


*See sub-skills  full details.*



- [orcaflex-modeling](../orcaflex-modeling/SKILL.md) - Run OrcaFlex simulations
- [orcaflex-post-processing](../orcaflex-post-processing/SKILL.md) - Process simulation results



- Existing Converters:
  - `src/digitalmodel/modules/orcaflex/orcaflex_yml_converter.py`
  - `src/digitalmodel/modules/orcaflex/examples_integration/batch_converter.py`
  - `src/digitalmodel/modules/orcaflex/examples_integration/orcfxapi_converter.py`
- OrcFxAPI Documentation
- YAML Specification: https://yaml.org/

---



- **** (-01-02): Initial release  bidirectional conversion, batch processing,  comprehensive reporting



- [Batch Converter Options (+)](batch-converter-options/SKILL.md)
- [File Organization (+)](file-organization/SKILL.md)



- [Version Metadata](version-metadata/SKILL.md)
- [[] - -01-07](--01-07/SKILL.md)
- [OrcaFlex File Types (+)](orcaflex-file-types/SKILL.md)
- [Pattern-Based Conversion (+)](pattern-based-conversion/SKILL.md)
- [Conversion Report (Markdown)](conversion-report-markdown/SKILL.md)
- [Summary](summary/SKILL.md)
- [Success Rate: %](success-rate-/SKILL.md)
- [Conversion Report (JSON)](conversion-report-json/SKILL.md)
- [Example OrcaFlex YAML Output](example-orcaflex-yaml-output/SKILL.md)
- [YAML Structure Validation (+)](yaml-structure-validation/SKILL.md)
- [Adding Conversion to Universal CLI](adding-conversion-to-universal-cli/SKILL.md)
- [ Version Control Preparation (+)](-version-control-preparation/SKILL.md)
- [Common Issues](common-issues/SKILL.md)
- [Benchmarks (+)](benchmarks/SKILL.md)