rfem-table-export 0.2.0

Terminal UI for exporting RFEM 6 input and result tables to Excel

rfem-table-export

A terminal UI (TUI) for exporting RFEM 6 tables — both model inputs and analysis results — to a formatted Excel workbook. It attaches to an already-running RFEM 6 process over the Dlubal gRPC API, lets you confirm the active model, pick tables from a tree that mirrors the RFEM GUI navigators, and writes a new timestamped .xlsx with one sheet per table plus an info sheet capturing export metadata and any warnings.

The table-picker UX is modeled on SAP2000's "Export Tables to Excel" dialog.

Features

• Attach to a live model — connects to the running RFEM 6 process and shows the active model's name and path so you can verify you're exporting the right one before you start.
• Navigator-style table tree — tables are organized exactly like the RFEM GUI (Structure → Basic Objects → Nodes, …; Load Cases and Combinations; Loads; Results → Nodes/Members/Lines/Surfaces).
• Inputs and results — model objects (nodes, members, surfaces, materials, cross-sections, supports, hinges, load cases/combinations, loads) and static result tables (support forces, internal forces, deformations) iterated across every load case and combination.
• Model units, no surprises — values are written exactly as the RFEM API returns them (the model's own units); the info sheet records this.
• One workbook per export — a new file is always written to results/; nothing is overwritten.
• Resilient — a single problematic table produces a warning on the info sheet rather than aborting the whole export.

Requirements

• Windows with RFEM 6.14 installed and running, a model open, and the gRPC web service / API enabled.
• A valid Dlubal API key (see Configuration).
• Python 3.11+.

Version pin: the dlubal-api client version must match the RFEM server version. This project pins dlubal-api==2.14.3 for RFEM 6.14. If you run a different RFEM version, change the pin to match — mismatched versions cause object-type enum drift and silently wrong/empty exports.

Installation

Run without installing (recommended)

With uv you can run the latest published release directly — no clone, no virtualenv:

uvx rfem-table-export

Pin a specific version (handy for matching your RFEM/dlubal-api version):

uvx rfem-table-export@0.2.0

The console command is also available as rfem-export; with uvx use the distribution name (rfem-table-export) so version pinning works.

From a clone (for development)

uv sync

Or with pip:

pip install -e .

Usage

1. Start RFEM 6, open and (for result tables) solve your model.

2. Launch the TUI:

   uv run rfem-export
   # or
   python -m rfem_export.app
   

3. Confirm the banner shows the correct active model.

4. Navigate the tree and toggle the tables you want:

   Key	Action
   space	Toggle table
   a	Select all
   n	Clear selection
   e	Export
   r	Reconnect to RFEM
   q	Quit

5. Press e. The workbook is written to results/rfem_export_<model>_<timestamp>.xlsx.

Configuration

The API key is resolved in this order:

1. --api-key command-line argument
2. RFEM_API_KEY environment variable
3. Dlubal's bundled config.ini ([api_keys] default = …), scanned across installed RFEM versions

uv run rfem-export --api-key YOUR_KEY

Project layout

rfem_export/
  __init__.py
  connection.py   # API-key resolution, attach to RFEM, model info, unit summary
  catalog.py      # curated navigator tree of exportable tables (TableDef / Group)
  extract.py      # protobuf objects + result tables -> pandas DataFrames
  excel.py        # workbook writer: one sheet per table + info sheet
  app.py          # Textual TUI + console entry point
examples/
  export_reactions.py   # original single-table proof-of-concept

Extending table coverage

Add a TableDef to the TREE in rfem_export/catalog.py. Both extraction and the TUI pick up new entries automatically — inputs are extracted by enumerating object IDs of an ObjectType; results via get_result_table across every loading.

Development

Lint and format with ruff (the same checks CI runs):

uvx ruff check .          # lint
uvx ruff format --check . # formatting
uvx ruff format .         # auto-format

Versioning & releases

The package version is derived automatically from git tags via hatch-vcs — there is no hardcoded version to bump. Tag vX.Y.Z becomes version X.Y.Z.

To cut a release:

git tag v0.2.0
git push origin v0.2.0

Pushing the tag triggers the Release workflow, which lints, builds the sdist/wheel, verifies the built version matches the tag, publishes to PyPI, and creates a GitHub release.

One-time PyPI setup: publishing uses Trusted Publishing (OIDC), so no API token is stored. On PyPI, add a trusted publisher for this project with: owner Mark-Milkis, repository rfem-table-export, workflow release.yml, and environment pypi. (For the very first publish you may need to use the "pending publisher" flow since the project doesn't exist on PyPI yet.)

License

MIT