You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tool-support/quantities_lib_generator/README.adoc
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ Author: Hans Peter de Koning, DEKonsult.
4
4
5
5
== Overview
6
6
7
-
This is a generator tool written in Python, that auto-generates the SysML v2 standard library packages for quantities and measurement references, in particular measurement units and coordinate frames.
7
+
This is a generator tool written in Python, that auto-generates the SysML v2 standard library packages for the ISO/IEC 80000 quantities and measurement references, in particular measurement units and coordinate frames.
8
8
9
-
The primary input is an Excel workbook that captures the ISQ quantities and as well as the SI measurement units defined in the ISO/IEC 80000 series of standards.
9
+
The primary input is an Excel workbook (`data/iso-iec-80000/iso_iec_80000_quantities_and_units.xlsx`) that captures the ISQ quantities and as well as the SI measurement units defined in the ISO/IEC 80000 series of standards.
10
10
11
-
Note. ISQ stands for ``International System of Quantities'', and ``SI'' stands for ``International System of Units''.
11
+
Note. ISQ stands for "International System of Quantities", and SI stands for "International System of Units".
12
12
13
-
The generator also contains tools to generate the USCustomaryUnits standard library package based on the official definitions, including their official conversion factors, as defined in NIST SP 811 Annex B.
13
+
A next release of the generator will also contain tools to generate the `USCustomaryUnits.sysml` standard library package based on the official definitions, including their official conversion factors, as defined in NIST SP 811 Annex B.
14
14
15
15
== Mathematical notation
16
16
@@ -48,9 +48,18 @@ The generator has been tested with Windows 11, but should run also on any MacOS
48
48
Run the generator and update the standard domain libraries
49
49
50
50
* Simplest is to run script `quantities_lib_generator.py` directly in the PyCharm IDE.
51
+
** Before first use, configure PyCharm as follows:
52
+
*** Via menu _File > Settings > Project > Python Interpreter_, select python v3.11 or higher using your favorite environment manager.
53
+
*** Install module `openpyxl`, for interaction with Excel `.xlsx` files.
54
+
** Open file `quantities_lib_generator.py` and run it by clicking the _run icon_ or selecting menu _Run_.
51
55
* In case no IDE is used:
52
-
** Ensure python v3.11 or higher is installed and available.
56
+
** Ensure python v3.11 or higher is installed, and accessible via the command line.
53
57
** Open a terminal and change the working directory to the `tool-support/quantities_lib_generator` folder.
0 commit comments