rfem-table-export 0.2.0__tar.gz → 0.3.0__tar.gz

{rfem_table_export-0.2.0 → rfem_table_export-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rfem-table-export
-Version: 0.2.0
+Version: 0.3.0
 Summary: Terminal UI for exporting RFEM 6 input and result tables to Excel
 Project-URL: Homepage, https://github.com/Mark-Milkis/rfem-table-export
 Project-URL: Repository, https://github.com/Mark-Milkis/rfem-table-export
@@ -22,6 +22,7 @@ Requires-Python: >=3.11
 Requires-Dist: dlubal-api==2.14.3
 Requires-Dist: openpyxl>=3.1
 Requires-Dist: pandas>=2.0
+Requires-Dist: pint>=0.20
 Requires-Dist: textual>=0.80
 Description-Content-Type: text/markdown
 
@@ -48,8 +49,30 @@ The table-picker UX is modeled on SAP2000's "Export Tables to Excel" dialog.
   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.
+- **Object filtering** (`o`) — toggle between *all objects* and *only the
+  objects currently selected in the RFEM model* (read live via the API's
+  `only_selected` query); the status bar shows a live count of what's selected
+  (e.g. "1 member"). To export a saved RFEM object selection or Group of Object
+  Selections, activate it in RFEM (which sets the live selection), then toggle to
+  *Currently selected objects*. Tables whose rows aren't tied to selectable
+  objects (materials, cross-sections, load cases/combinations) ignore the filter
+  and always export in full; loads, supports and result rows are filtered by the
+  object they act on/report.
+- **Case / combination filtering** (`c`) — for result tables, pick exactly which
+  load cases and combinations to export from a check-list instead of iterating
+  every one.
+- **Result-row detail** (`t`) — cycle a result table's rows between *all*,
+  *envelope only* (extreme rows whose `tag` ends in `min`/`max`), and *itemized
+  only* (the per-location rows, with no `min`/`max` tag).
+- **Analysis-aware** — result tables are greyed out and unselectable until the
+  model has been solved, so you never queue a result export that can't run.
+- **Metric or imperial units** — pick a unit system and every value is
+  converted to it (metric: kN, kN·m, m/mm, MPa; imperial: kip, kip·ft, ft/in,
+  ksi). Conversion is dimensionality-driven via [Pint](https://pint.readthedocs.io/):
+  no multipliers are hard-coded, so compound units (kN·m, kN/m, kN/m²) convert
+  correctly and can't be cross-applied. The info sheet records the system and
+  the target unit for each magnitude; converted columns carry their unit in the
+  header (e.g. `n [kip]`, `area_axial [in²]`).
 - **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
@@ -113,16 +136,41 @@ pip install -e .
 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              |
+   | Key     | Action                                    |
+   |---------|-------------------------------------------|
+   | `space` | Toggle table                              |
+   | `a`     | Select all                                |
+   | `n`     | Clear selection                           |
+   | `o`     | Object scope (all / currently selected)   |
+   | `c`     | Case & combination filter (results)       |
+   | `t`     | Result rows (all / envelope / itemized)   |
+   | `u`     | Cycle units (metric/imperial)             |
+   | `e`     | Export                                     |
+   | `r`     | Reconnect to RFEM                          |
+   | `q`     | Quit                                      |
 
 5. Press `e`. The workbook is written to `results/rfem_export_<model>_<timestamp>.xlsx`.
+   The info sheet records the active object and case filters, and each table's
+   row lists how many rows the filter kept.
+
+## Units
+
+Choose the unit system with `u` in the TUI, or `--units {metric,imperial}` on
+the command line (default: `imperial`). Values are converted by *dimensionality*,
+never by a hard-coded factor:
+
+- **Input tables** carry a unit per column straight from the RFEM API
+  (`m`, `kN`, `kNm`, `mm⁴`, …). Pint parses that unit, derives its dimensionality
+  and computes the conversion.
+- **Result tables** expose no units over the API, so each result table declares
+  the *SI* unit of its value columns (in [`catalog.py`](rfem_export/catalog.py)).
+  Only the dimension is asserted — Pint still computes every factor.
+
+A length lands in feet/metres for geometry but inches/millimetres for section
+dimensions and deflections (RFEM's own unit categories drive this). Quantities
+with no conversion rule (e.g. dimensionless ratios) are passed through unchanged
+and noted in the export log. If Pint isn't installed, values are written in
+their source units and the info sheet says so.
 
 ## Configuration
 
@@ -144,7 +192,8 @@ 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
+  units.py        # Pint-based, dimensionality-driven metric/imperial conversion
+  extract.py      # object tables + result tables -> pandas DataFrames (+ units)
   excel.py        # workbook writer: one sheet per table + info sheet
   app.py          # Textual TUI + console entry point
 examples/
@@ -154,9 +203,11 @@ examples/
 ### Extending table coverage
 
 Add a `TableDef` to the `TREE` in [`rfem_export/catalog.py`](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.
+Both extraction and the TUI pick up new entries automatically — inputs via
+`get_object_table` for an `ObjectType` (which also supplies per-column units);
+results via `get_result_table` across every loading. For a **result** table,
+also fill in `result_units` (the SI unit of each value column) so the values can
+be converted — result tables carry no units over the API.
 
 ## Development
 

{rfem_table_export-0.2.0 → rfem_table_export-0.3.0}/README.md

@@ -21,8 +21,30 @@ The table-picker UX is modeled on SAP2000's "Export Tables to Excel" dialog.
   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.
+- **Object filtering** (`o`) — toggle between *all objects* and *only the
+  objects currently selected in the RFEM model* (read live via the API's
+  `only_selected` query); the status bar shows a live count of what's selected
+  (e.g. "1 member"). To export a saved RFEM object selection or Group of Object
+  Selections, activate it in RFEM (which sets the live selection), then toggle to
+  *Currently selected objects*. Tables whose rows aren't tied to selectable
+  objects (materials, cross-sections, load cases/combinations) ignore the filter
+  and always export in full; loads, supports and result rows are filtered by the
+  object they act on/report.
+- **Case / combination filtering** (`c`) — for result tables, pick exactly which
+  load cases and combinations to export from a check-list instead of iterating
+  every one.
+- **Result-row detail** (`t`) — cycle a result table's rows between *all*,
+  *envelope only* (extreme rows whose `tag` ends in `min`/`max`), and *itemized
+  only* (the per-location rows, with no `min`/`max` tag).
+- **Analysis-aware** — result tables are greyed out and unselectable until the
+  model has been solved, so you never queue a result export that can't run.
+- **Metric or imperial units** — pick a unit system and every value is
+  converted to it (metric: kN, kN·m, m/mm, MPa; imperial: kip, kip·ft, ft/in,
+  ksi). Conversion is dimensionality-driven via [Pint](https://pint.readthedocs.io/):
+  no multipliers are hard-coded, so compound units (kN·m, kN/m, kN/m²) convert
+  correctly and can't be cross-applied. The info sheet records the system and
+  the target unit for each magnitude; converted columns carry their unit in the
+  header (e.g. `n [kip]`, `area_axial [in²]`).
 - **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
@@ -86,16 +108,41 @@ pip install -e .
 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              |
+   | Key     | Action                                    |
+   |---------|-------------------------------------------|
+   | `space` | Toggle table                              |
+   | `a`     | Select all                                |
+   | `n`     | Clear selection                           |
+   | `o`     | Object scope (all / currently selected)   |
+   | `c`     | Case & combination filter (results)       |
+   | `t`     | Result rows (all / envelope / itemized)   |
+   | `u`     | Cycle units (metric/imperial)             |
+   | `e`     | Export                                     |
+   | `r`     | Reconnect to RFEM                          |
+   | `q`     | Quit                                      |
 
 5. Press `e`. The workbook is written to `results/rfem_export_<model>_<timestamp>.xlsx`.
+   The info sheet records the active object and case filters, and each table's
+   row lists how many rows the filter kept.
+
+## Units
+
+Choose the unit system with `u` in the TUI, or `--units {metric,imperial}` on
+the command line (default: `imperial`). Values are converted by *dimensionality*,
+never by a hard-coded factor:
+
+- **Input tables** carry a unit per column straight from the RFEM API
+  (`m`, `kN`, `kNm`, `mm⁴`, …). Pint parses that unit, derives its dimensionality
+  and computes the conversion.
+- **Result tables** expose no units over the API, so each result table declares
+  the *SI* unit of its value columns (in [`catalog.py`](rfem_export/catalog.py)).
+  Only the dimension is asserted — Pint still computes every factor.
+
+A length lands in feet/metres for geometry but inches/millimetres for section
+dimensions and deflections (RFEM's own unit categories drive this). Quantities
+with no conversion rule (e.g. dimensionless ratios) are passed through unchanged
+and noted in the export log. If Pint isn't installed, values are written in
+their source units and the info sheet says so.
 
 ## Configuration
 
@@ -117,7 +164,8 @@ 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
+  units.py        # Pint-based, dimensionality-driven metric/imperial conversion
+  extract.py      # object tables + result tables -> pandas DataFrames (+ units)
   excel.py        # workbook writer: one sheet per table + info sheet
   app.py          # Textual TUI + console entry point
 examples/
@@ -127,9 +175,11 @@ examples/
 ### Extending table coverage
 
 Add a `TableDef` to the `TREE` in [`rfem_export/catalog.py`](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.
+Both extraction and the TUI pick up new entries automatically — inputs via
+`get_object_table` for an `ObjectType` (which also supplies per-column units);
+results via `get_result_table` across every loading. For a **result** table,
+also fill in `result_units` (the SI unit of each value column) so the values can
+be converted — result tables carry no units over the API.
 
 ## Development
 

{rfem_table_export-0.2.0 → rfem_table_export-0.3.0}/pyproject.toml

@@ -23,6 +23,7 @@ dependencies = [
     "textual>=0.80",
     "pandas>=2.0",
     "openpyxl>=3.1",
+    "pint>=0.20",
 ]
 
 [project.urls]
@@ -79,5 +80,6 @@ select = ["E", "F", "I", "W", "UP", "B"]
 "rfem_export/catalog.py" = ["E501"]
 # Side-effect import ordering must be preserved (see comment in the module).
 "rfem_export/extract.py" = ["I001", "E402", "E501"]
+"rfem_export/filters.py" = ["I001", "E402"]
 # Dlubal path injection happens before the dlubal import by design.
 "rfem_export/connection.py" = ["E402"]

{rfem_table_export-0.2.0 → rfem_table_export-0.3.0}/rfem_export/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
 
 __commit_id__ = commit_id = None