Merge pull request #15 from openfedem/run-fmu-fix

Installation guide update and new versions

Author: kmokstad

docs/examples/digital_twins.md

@@ -116,7 +116,7 @@ my_model.edit_triad(t3, load={'Tz' : my_model.make_function('Wheel force', tag='
 # Ouput sensors
 my_model.make_sensor('Damper force', (s1, d1), FmVar.FORCE, tag='damper_force')
 my_model.make_sensor('Damper deformation', s1, FmVar.DEFLECTION, tag='damper_deformation')
-my_model.make_sensor('Steering pin deflection', t0, FmVar.POS, FmDof.TZ, tag='pin_deflection')
+my_model.make_sensor('Steering pin deflection', t0, FmVar.POS, FmDof.TZ, 'pin_deflection')
 
 my_model.fm_solver_setup(t_inc=0.005, t_end=2.5, t_quasi=-1.0)
 my_model.fm_solver_tol(1.0e-6,1.0e-6,1.0e-6)
@@ -142,7 +142,7 @@ You find this in the *File* menu (*File --> Export --> Export Digital Twin...*).
 
 This dialog box shows three alternative ways of exporting the model,
 but only the **FMU** option is relevant here. So enable that toggle.
-Then use the **Browse...** button to selected the name for the fmu-file.
+Then use the **Browse...** button to select the name for the fmu-file.
 In the right side of the dialog, you find a list of the input- and output
 indicators in the model, corresponding to the external functions
 and output sensors defined in the modelling script.
@@ -232,9 +232,10 @@ Use this as a template for more advanced co-simulation tasks with FEDEM FMUs.
 [Download...](linked_files/run_fedem_fmu.py)
 
 ```python
-from fmpy import fmi2, read_model_description, extract
-from pandas import read_csv
 from sys import argv
+from os import path
+from pandas import read_csv
+from fmpy import fmi2, read_model_description, extract
 
 
 def run(fmu_file, input_file=None, instance_name="my instance"):
@@ -249,6 +250,11 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     print("Extracting", fmu_file, "...")
     unzipdir = extract(fmu_file)
 
+    # Get absolute path of input_file because the fmu.instantiate() call
+    # will change the working directory
+    if input_file is not None:
+        input_file = path.abspath(input_file)
+
     # Setup the FMU
     print("Setup the FMU", model.coSimulation.modelIdentifier)
     fmu = fmi2.FMU2Slave(guid=model.guid, unzipDirectory=unzipdir,
@@ -263,16 +269,15 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     num_inputs = num_params[0] # Number of input sensors
     num_output = num_params[1] # Number of output sensors
 
-    # Read the input values into a Dataframe
-    if input_file is None:
-        inputs = None
-    elif num_inputs > 0:
-        inputs = read_csv(input_file, sep="\t")
+    if input_file is None or num_inputs < 1:
+        inputs = None  # All inputs are assumed defined internally in the model
+    else:  # Read the input values into a Dataframe
+        inputs = read_csv(input_file, sep=",")
 
     # List of external function indices
-    inpIdx = range(num_inputs)
+    inp_idx = range(num_inputs)
     # List of output sensor indices
-    outIdx = range(num_inputs,num_inputs+num_output)
+    out_idx = range(num_inputs, num_inputs+num_output)
 
     # Time loop, this will run through the FEDEM simulation
     # using the time domain setup of the model file used to export the FMU.
@@ -282,13 +287,13 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     while not fmu.getBooleanStatus(fmi2.fmi2Terminated):
         if inputs is not None:  # Set external function values for next step
             # First column of inputs is not used, assuming it contains the time
-            fmu.setReal([*inpIdx], inputs.iloc[step].tolist()[1:])
+            fmu.setReal([*inp_idx], inputs.iloc[step].tolist()[1:])
 
         fmu.doStep(0.0, 0.0)  # Advance the simulation on step
 
         step += 1
         time = fmu.getRealStatus(fmi2.fmi2LastSuccessfulTime)
-        output = fmu.getReal([*outIdx])
+        output = fmu.getReal([*out_idx])
         print(f"Here are the outputs at step={step} time={time}:", output)
 
     # Finished, close down

docs/examples/linked_files/loader_modeling_and_solving.py

@@ -37,6 +37,9 @@
 
 # Load the FE parts
 parts = [my_model.make_fe_part(f) for f in FILES]
+if any(p < 0 for p in parts):
+    print("Failed to load FE parts")
+    exit(1)
 
 # Edit some part properties
 my_model.edit_part(parts, alpha2=0.00286, component_modes=0, consistent_mass=True)
@@ -130,7 +133,8 @@
                     constraints={'Rz' : FmDofStat.SPRING},
                     spring={'Rz' : 1.0e9},
                     length={'Rz' : f3})
-[my_model.edit_joint(j, Rx=90) for j in [j03, j04, j05, j06, j07, j08, j09, j10]]
+for j in [j03, j04, j05, j06, j07, j08, j09, j10]:
+    my_model.edit_joint(j, Rx=90)
 
 my_model.fm_solver_setup(t_inc=0.01, t_end=1.6)
 my_model.close(True, True)

docs/examples/linked_files/run_fedem_fmu.py

@@ -8,9 +8,10 @@
 Usage: python -m run_fedem_fmu <fmu-file> <input-file>
 """
 
-from fmpy import fmi2, read_model_description, extract
-from pandas import read_csv
 from sys import argv
+from os import path
+from pandas import read_csv
+from fmpy import fmi2, read_model_description, extract
 
 
 def run(fmu_file, input_file=None, instance_name="my instance"):
@@ -25,6 +26,11 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     print("Extracting", fmu_file, "...")
     unzipdir = extract(fmu_file)
 
+    # Get absolute path of input_file because the fmu.instantiate() call
+    # will change the working directory
+    if input_file is not None:
+        input_file = path.abspath(input_file)
+
     # Setup the FMU
     print("Setup the FMU", model.coSimulation.modelIdentifier)
     fmu = fmi2.FMU2Slave(guid=model.guid, unzipDirectory=unzipdir,
@@ -39,16 +45,15 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     num_inputs = num_params[0] # Number of input sensors
     num_output = num_params[1] # Number of output sensors
 
-    # Read the input values into a Dataframe
-    if input_file is None:
-        inputs = None
-    elif num_inputs > 0:
+    if input_file is None or num_inputs < 1:
+        inputs = None  # All inputs are assumed defined internally in the model
+    else:  # Read the input values into a Dataframe
         inputs = read_csv(input_file, sep=",")
 
     # List of external function indices
-    inpIdx = range(num_inputs)
+    inp_idx = range(num_inputs)
     # List of output sensor indices
-    outIdx = range(num_inputs,num_inputs+num_output)
+    out_idx = range(num_inputs, num_inputs+num_output)
 
     # Time loop, this will run through the FEDEM simulation
     # using the time domain setup of the model file used to export the FMU.
@@ -58,13 +63,13 @@ def run(fmu_file, input_file=None, instance_name="my instance"):
     while not fmu.getBooleanStatus(fmi2.fmi2Terminated):
         if inputs is not None:  # Set external function values for next step
             # First column of inputs is not used, assuming it contains the time
-            fmu.setReal([*inpIdx], inputs.iloc[step].tolist()[1:])
+            fmu.setReal([*inp_idx], inputs.iloc[step].tolist()[1:])
 
         fmu.doStep(0.0, 0.0)  # Advance the simulation on step
 
         step += 1
         time = fmu.getRealStatus(fmi2.fmi2LastSuccessfulTime)
-        output = fmu.getReal([*outIdx])
+        output = fmu.getReal([*out_idx])
         print(f"Here are the outputs at step={step} time={time}:", output)
 
     # Finished, close down

docs/examples/linked_files/sla-dtwin.fmu

@@ -30,6 +30,9 @@
 lca     = my_model.make_fe_part(PARTS_PATH + 'lca.nas')
 knuckle = my_model.make_fe_part(PARTS_PATH + 'knuckle.nas')
 uca     = my_model.make_fe_part(PARTS_PATH + 'uca.nas')
+if any(p < 0 for p in [lca, knuckle, uca]):
+    print("Loading FE parts failed")
+    exit(1)
 
 # Lower control arm joints to ground
 j1 = my_model.make_joint('Fix 1', FmType.BALL_JOINT,

docs/examples/linked_files/sla_modeling.py

@@ -5,15 +5,15 @@ the latest built release, and run some of the example models provided.
 
 ## Installation
 
-64-bit binaries are now provided for both Windows and Linux (Ubuntu 22.04).
+64-bit binaries are provided for Windows and Linux (Ubuntu 22.04) platform.
 To install the latest Windows release, proceed as follows:
 
-* Go to the [Releases](https://github.com/openfedem/fedem-gui/releases) page
-  on the [fedem-gui](https://github.com/openfedem/fedem-gui) repository on github,
-  and download the most recent zip-file `FedemInstaller-*.zip`.
-* Alternatively, you may download the latest Windows installer
-  from the **Download** menu in the left pane.
-* Unzip this file at arbitrary location on your PC.
+* Go to the **Download** menu in the left pane and choose **Windows installer (zip)**.
+  This will download a zip-file `FedemInstaller-*.zip` with the latest installation.
+  You may also go to the [Releases](https://github.com/openfedem/fedem-gui/releases)
+  page of the [fedem-gui](https://github.com/openfedem/fedem-gui) repository
+  on github if you need to download some of the earlier releases.
+* Unzip the downloaded file at arbitrary location on your PC.
 * Execute the `INSTALL.bat` file as administrator.
   This will (by default) install the software in the folder "C:\Program Files\FEDEM"
   on your PC, set the file association for FEDEM model files to the GUI executable
@@ -26,12 +26,12 @@ To install the latest Windows release, proceed as follows:
   That is, download the file [vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe)
   and execute it as administrator.
 
-To install the latest Linux release,
-download the most recent `Fedem-*_Ubuntu-22.04.tar.gz` file
-from the [Releases](https://github.com/openfedem/fedem-gui/releases) page
-(it is also available from the  **Download** menu in the left pane).
+To install the latest Linux release, choose **Linux installation (tar.gz)**
+from the **Downlad** menu in the left pane. This will download a compressed tar-file
+`Fedem-*_Ubuntu-22.04.tar.gz` with the latest Linux installation. You will also find this
+ and earlier versions on the [Releases](https://github.com/openfedem/fedem-gui/releases) page.
 
-Unpack this file in the location where you want to have Fedem installed, e.g.:
+Unpack the downloaded file in the location where you want to have Fedem installed, e.g.:
 
     $ cd /usr/local
     $ sudo tar zxfv ~/Downloads/Fedem-R8.1.1_Ubuntu-22.04.tar.gz

docs/installation_guide.md

@@ -8,23 +8,23 @@ repo_url: https://github.com/openfedem/fedem-gui/
 nav:
   - Welcome: index.md
   - Getting started:
-    - Installation Guide: installation_guide.md
-    - Development Setup: development_setup.md
+    - Installation guide: installation_guide.md
+    - Development setup: development_setup.md
     - Python API (fedempy): python_api.md
   - Download:
-    - Windows installer (zip): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.1/FedemInstaller-R8.1.1.zip
-    - Linux installation (tar.gz): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.1/Fedem-R8.1.1_Ubuntu-22.04.tar.gz
-    - Linux solvers (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.1/fedem-solvers-4.1.1_linux64.tar.gz
-    - fedempy package (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.1/fedempy-4.1.1.tar.gz
+    - Windows installer (zip): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.2/FedemInstaller-R8.1.2.zip
+    - Linux installation (tar.gz): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.2/Fedem-R8.1.2_Ubuntu-22.04.tar.gz
+    - Windows solvers (zip): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.1.3/fedem-solvers-4.1.3_win64.zip
+    - Linux solvers (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.1.3/fedem-solvers-4.1.3_linux64.tar.gz
+    - fedempy package (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fmu-8.1.2/fedempy-4.2.1.tar.gz
   - Documentation:
-    - User Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.1/FedemUsersGuide.pdf
-    - Theory Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.1/FedemTheoryGuide.pdf
+    - User guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.1/FedemUsersGuide.pdf
+    - Theory guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.1/FedemTheoryGuide.pdf
     - Python API (fedempy): https://openfedem.github.io/fedem-solvers/fedempy/
     - Solver source code: https://openfedem.github.io/fedem-solvers/solver/
     - Tutorials: tutorials.md
-    - YouTube videos: youtube_videos.md
   - Discussions: discussions.md
-  - Issues (Bugs): issues.md
+  - Issues (bugs): issues.md
   - Examples:
     - Introduction: examples/introduction.md
     - The Loader: examples/loader.md
@@ -33,10 +33,11 @@ nav:
       #- Model imports: examples/C_imports.md
       #- Industrial applications: examples/D_industrial_applications.md
       #- Simulators: examples/E_simulators.md
-    - Digital Twins: examples/digital_twins.md
       #- Benchmarks: examples/G_case_studies.md
       #- Physics cases: examples/H_physics.md
       #- API: examples/I_api.md
+  - Digital twins: examples/digital_twins.md
+  - Training videos: youtube_videos.md
   - Developer area: developer_area.md
   - Partner area: partner_area.md