Skip to content

Commit 7c45184

Browse files
committed
Updated README.adoc with instructions to install module openpyxl and some additional minor corrections.
1 parent 8136464 commit 7c45184

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

tool-support/quantities_lib_generator/README.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Author: Hans Peter de Koning, DEKonsult.
44

55
== Overview
66

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.
88

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.
1010

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".
1212

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.
1414

1515
== Mathematical notation
1616

@@ -48,9 +48,18 @@ The generator has been tested with Windows 11, but should run also on any MacOS
4848
Run the generator and update the standard domain libraries
4949

5050
* 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_.
5155
* 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.
5357
** Open a terminal and change the working directory to the `tool-support/quantities_lib_generator` folder.
58+
** Install module `openpyxl` e.g. using:
59+
+
60+
....
61+
$ pip install openpyxl
62+
....
5463
** Run the following command:
5564
+
5665
....

0 commit comments

Comments
 (0)