Merge branch 'dev'

Author: Nicolas Laurent

.gitignore

@@ -32,3 +32,8 @@ tests/containers/arch/flat.fmu
 tests/containers/arch/reversed.fmu
 tests/containers/ssp/bouncing.fmu
 tests/containers/ssp/bouncing
+tests/containers/ssp/bouncing-dump.json
+tests/containers/ssp/bouncing.fmu
+tests/containers/arch/flat-dump.json
+tests/containers/arch/hierarchical-dump.json
+tests/containers/arch/reversed-dump.json

CHANGELOG.md

@@ -1,7 +1,11 @@
 # FMU Manipulation Toolbox changelog
-This package was formerly know as `fmutool`.
+This package was formerly known as `fmutool`.
 
 
+## Version 1.8.1
+* FIXED: `fmucontainer` read links from `.json` input files
+* CHANGED: switch to PyQT6 and add minor GUI improvements
+
 ## Version 1.8
 * CHANGE: Package in now known as `fmu_manipulation`
 * ADDED: `fmucontainer` support `canHandleVariableCommunicationStepSize`

README.md

@@ -122,22 +122,24 @@ optional arguments:
 ### FMU Containers
 
 ```
-fmucontainer [-h] -fmu-directory FMU_DIRECTORY [-container filename.csv:step_size] [-debug] [-no-auto-input]
-             [-no-auto-output] [-no-auto-link] [-mt] [-profile]
+usage: fmucontainer [-h] [-fmu-directory FMU_DIRECTORY] -container filename.{csv|json|ssp},[:step_size] [-debug]
+                    [-no-auto-input] [-no-auto-output] [-no-auto-link] [-mt] [-profile] [-dump-json]
 
 Generate FMU from FMU's
 
 optional arguments:
   -h, -help
-  -fmu-directory FMU_DIRECTORY      Directory containing initial FMU’s and used to generate containers. (default: None)
-  -container filename.csv:step_size
+  -fmu-directory FMU_DIRECTORY      Directory containing initial FMU’s and used to generate containers. If not defined,
+                                    current directory is used. (default: .)
+  -container filename.{csv|json|ssp},[:step_size]
                                     Description of the container to create. (default: [])
   -debug                            Add lot of useful log during the process. (default: False)
   -no-auto-input                    Create ONLY explicit input. (default: True)
   -no-auto-output                   Create ONLY explicit output. (default: True)
   -no-auto-link                     Create ONLY explicit links. (default: True)
   -mt                               Enable Multi-Threaded mode for the generated container. (default: False)
   -profile                          Enable Profiling mode for the generated container. (default: False)
+  -dump-json                        Dump a JSON file for each container. (default: False)
 ```
 
 ## API

container/README.md

@@ -1,13 +1,4 @@
-
 # FMU Containers ?
 
-A FMU Container is classical FMU which embeds other's FMU's.
-
-![FMU Container](../doc/FMUContainer.png "FMU Container")
-
-
-# ROUTING TABLE
-
-Signals routing between embedded FMU's is defined through a CSV file.
+A FMU Container is classical FMU which embeds other's FMU's. See [FMU Container](../doc/container.md)
 
-![Routing](../doc/routing.png "Routing table")

doc/container.md

@@ -0,0 +1,44 @@
+# FMU Containers ?
+
+A FMU Container is classical FMU which embeds other's FMU's.
+![FMU Container](../doc/FMUContainer.png "FMU Container")
+FMU Manipulation Toolbox ships `fmucontainer` command which makes easy to embed FMU's into FMU.
+
+
+# FMU Container Description
+
+A FMU Container is described by multiple parameters:
+
+- time step: a FMU Container acts as a fixed step time "solver".
+- optional feature
+  - multi-threading: 
+  - profiling
+- routing table
+  - Input ports
+  - Output ports
+  - Connexions between embedded FMU's
+  - Explicitly ignored ports (only port with causality = "output" can be ignored)
+- Automatic routing table
+  - expose automatically ports of embedded FMU's with causality = "input"
+  - expose automatically ports of embedded FMU's with causality = "output"
+  - link automatically ports of embedded FMU's which are left previously unconnected and have the same names and types
+
+Some of these parameters can be defined by Command Line Interface or by input files.
+
+Several formats are supported for input files:
+- a `CSV` format: define only the routing table. Other options are defined witch CLI.
+- a `JSON` file: all parameters can be defined in the file. CLI can defined default values if option is not present in
+  `JSON` file.
+- a `SSP` file. See [ssp-standard.org](https://ssp-standard.org). define only the routing table. Other options are
+  defined witch CLI.
+
+![Routing](../doc/routing.png "Routing table")
+
+## CSV Input file
+
+## Json Input file
+
+## SSP Input file
+
+
+