From 7790974f5ddd2c38bf21098973ae4e3a21a9024c Mon Sep 17 00:00:00 2001 From: Lutz Wrage Date: Mon, 11 Mar 2024 07:23:39 -0400 Subject: [PATCH 1/3] Installation instructions --- INSTALL.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..12beb04 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,7 @@ +As a prerequisite for using the contract annex Python and Z3 must be installed in addition to OSATE and the contract annex plugins. +Here we describe how to acomplish this on Windows. + +1. Install Python 3.11 or greater + - Download the installer for Windows from https://www.python.org/downloads/windows/. In most cases "Windows installer (64bit)" will be the correct package. + - Run the installer. Depending on the configuration of the Windows computer you may need to enter your password or use a separate administrator + account for the installation. From 780834faeda7655b85e2266e3cb5f4782565a02c Mon Sep 17 00:00:00 2001 From: Lutz Wrage Date: Mon, 11 Mar 2024 13:39:04 -0400 Subject: [PATCH 2/3] add to components directory --- deploy.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy.sh b/deploy.sh index 776de01..817bb5e 100644 --- a/deploy.sh +++ b/deploy.sh @@ -1,7 +1,7 @@ set -x FROMDIR=org.osate.contract.repository/target/repository -TODIR=/var/www/html/p2/contract-annex +TODIR=/var/www/html/download/osate/components/contract-annex rm -fr ${TODIR} mkdir -p ${TODIR} From 9c9aa80afae10100a62d63c8b94a23d1b480209e Mon Sep 17 00:00:00 2001 From: Lutz Wrage Date: Mon, 11 Mar 2024 13:43:58 -0400 Subject: [PATCH 3/3] Add installation instructions (for Windows). --- INSTALL.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 12beb04..992cda0 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,7 +1,26 @@ -As a prerequisite for using the contract annex Python and Z3 must be installed in addition to OSATE and the contract annex plugins. -Here we describe how to acomplish this on Windows. +# Installation of Contract Annex support for OSATE -1. Install Python 3.11 or greater - - Download the installer for Windows from https://www.python.org/downloads/windows/. In most cases "Windows installer (64bit)" will be the correct package. - - Run the installer. Depending on the configuration of the Windows computer you may need to enter your password or use a separate administrator - account for the installation. +The contract annex support for OSATE consists of the contract annex plug-ins together with a separate installation +of Python and the Z3 library for Python. + +The contract annex OSATE plug-ins can be installed from within OSATE as an additional component via +_Help_ > _Install Additional OSATE Components_ . This brings up a dialog with a list of available components. +Select "Contract Annex" from the list of SEI Components and click _Finish_ . After installation of the pug-ins OSATE must be +re-started. + +A Python interpreter must be installed separately for the underlying operating system. A Python installer can be downloaded +from https://www.python.org/downloads/. The following assumes a Windows 10/11 operating system that is not locked down by +an organization specific policy. + +Run the installer by double clicking on the downloaded program. In the installer check the option "Add Python 3.x to PATH." +In addition the option to install the py launcher should be checked. After installation start a command window +(cmd.exe or powershell) and run the command `py`. This should start the Python interpreter and print a welcome message. +Type exit() or Ctrl-Z followed by Return to exit. + +The next step is to install the Python package z3-solver using using the pip command, which was installed together with the +Python interpreter. In a command window run + +`pip install z3-solver` + +In the final step, configure OSATE to use the command `py` to run Python scripts. Start OSATE and go to _Window_ > +_Preferences_ > _Scripting_ > _Python Scripting (using Py4J)_ , type `py` into the Python location text field and click _Apply and Close_ .