Create easily installable packages of FORCE tools #37

j-bryan · 2024-09-30T20:48:42Z

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

#36

What are the significant changes in functionality due to this change request?

Uses the cx_Freeze package to create executables of RAVEN, HERON, and TEAL main scripts with a self-contained Python environment.
Adds a simple launcher GUI to run RAVEN, HERON, and TEAL files without interacting with a command line.
Creates scripts to automate the creation of the frozen executables.
Scripts the creation of a macOS app bundle for FORCE tools with NEAMS Workbench.
Uses an Inno Setup script to create a Windows installer executable.
Automatically configures Workbench to be able to create *.heron files and run HERON workflows for both macOS and Windows installations.
Includes selected documentation and examples (from RAVEN and HERON test directories) in the installer bundle.

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

1. Review all computer code.
2. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
3. Automated Tests should pass, including run_tests, pylint, and manual building tests.
4. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test.
5. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
6. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.

So instead we can manually run print_loc.py to get the file, and then copy and past that into setup.py instead of using the import.

…statements to GUI text

* Adds a basic GUI to run HERON and RAVEN * Makes minor changes to package requirements for installation

* Handles ipopt files for building executable * Fixes issue for netCDF4 import on Windows

package/raven_framework.py

joshua-cogliati-inl

I have reviewed this and overall, it looks reasonable. I left a few comments. (I contributed to this pull so I can't approve by myself.)

package/ui/controllers/file_selection.py

package/ui/utils.py

joshua-cogliati-inl

I ran thru the README instructions on windows, and it generally worked. Thank you. I left some comments.

package/build_force.sh

package/README.md

joshua-cogliati-inl

Thanks for the changes. No new comments.

dylanjm

Just a small update to documentation then should be ready to merge.

package/README.md

dylanjm

Changes are good to merge. Thanks!

joshua-cogliati-inl and others added 30 commits December 12, 2023 10:11

Adding some scripts to make a cx_Freeze package.

4ac252d

Adding support for a heron command.

a002a6e

On windows, the code to get this in setup.py was segfaulting.

15ae2ad

So instead we can manually run print_loc.py to get the file, and then copy and past that into setup.py instead of using the import.

modifications for mac build

70d5129

basic working GUI; has a hard time redirecting HERON and RAVEN print …

e2dc396

…statements to GUI text

simplify to only support running functions, not scripts

ee8a95e

Attempt at finding ipopt.

35040f4

Fixing bug.

ed0b2ab

refactoring of GUI into MVC paradigm

38da25a

fixes status panel updates

5495be4

GUI for running raven and heron

a300dc1

fixes ctrl+c command to close window

b6e3f66

working example with ipopt

98ee262

Merge branch 'gui' into installation

167d624

* Adds a basic GUI to run HERON and RAVEN * Makes minor changes to package requirements for installation

Merge branch 'finding_ipopt' into installation

d773e6f

* Handles ipopt files for building executable * Fixes issue for netCDF4 import on Windows

OS handling in setup; general cleanup

f3df54d

driver for TEAL

78d09aa

Initial inno file.

64b24a1

Adding raven and heron icons.

90c0cc7

Adding icons for heron and raven.

c92287f

adds TEAL standalone with GUI

c61cd34

Merge remote-tracking branch 'origin/main' into inno_work

3b5d87b

rework of file input specification

78eb22a

fixes input file spec handling for raven_framework

920177c

Adding teal icon.

1de277d

Merge remote-tracking branch 'j-bryan/teal' into inno_work

9b877b5

Adding TEAL to inno file.

7437180

Adding script directory so raven runs raven works.

5ba00da

Removing including ipopt in setup.py

13e03c5

better CLI argument handling and default directory for file browsers

db6718f

j-bryan and others added 19 commits May 1, 2024 16:28

adds examples and docs to build directory

e3bbed8

install Workbench after installing FORCE

350b691

install Workbench after running FORCE installer

6dd0afa

configuring workbench for heron by default

38bcf6f

open Workbench from HERON launcher

c5a5ca1

build script for mac

a91046f

build mac FORCE app with applescript launcher

b6eff91

adding correct force icon

57b0895

mac build tweaks

06a588d

GUI updates and finding Workbench

5e567a1

better utilities for finding workbench installation

11b25c5

heron file windows registry fix

424661d

model running status indicator

2f112a6

run workbench installer silently

f5a81ec

no need to look for Workbench install location

c60a7e3

fixes for mac build

ea7f999

simplified FORCE build scripts

4e540fd

Merge branch 'idaholab:main' into package_build

c65a73a

removes old commented code

79d191f

dylanjm reviewed Sep 30, 2024

View reviewed changes

package/raven_framework.py Show resolved Hide resolved

joshua-cogliati-inl reviewed Oct 9, 2024

View reviewed changes

package/ui/controllers/file_selection.py Outdated Show resolved Hide resolved

package/ui/utils.py Outdated Show resolved Hide resolved

joshua-cogliati-inl reviewed Oct 11, 2024

View reviewed changes

package/build_force.sh Outdated Show resolved Hide resolved

package/README.md Outdated Show resolved Hide resolved

package/README.md Outdated Show resolved Hide resolved

package/README.md Show resolved Hide resolved

j-bryan added 3 commits October 11, 2024 11:39

converts from 4-space indents to 2-space indents

9d8dc6c

run in workbench on linux like on windows

14b9f20

updates to readme instructions

6ef0998

joshua-cogliati-inl reviewed Oct 11, 2024

View reviewed changes

dylanjm requested changes Oct 15, 2024

View reviewed changes

package/README.md Show resolved Hide resolved

dylanjm approved these changes Oct 17, 2024

View reviewed changes

dylanjm merged commit 6ef7bd9 into idaholab:main Oct 17, 2024
1 check passed

dylanjm mentioned this pull request Oct 17, 2024

[TASK] Create easily installable software packages for FORCE tools #36

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create easily installable packages of FORCE tools #37

Create easily installable packages of FORCE tools #37

j-bryan commented Sep 30, 2024

joshua-cogliati-inl left a comment

joshua-cogliati-inl left a comment

joshua-cogliati-inl left a comment

dylanjm left a comment

dylanjm left a comment

Create easily installable packages of FORCE tools #37

Create easily installable packages of FORCE tools #37

Conversation

j-bryan commented Sep 30, 2024

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

What are the significant changes in functionality due to this change request?

For Change Control Board: Change Request Review

joshua-cogliati-inl left a comment

Choose a reason for hiding this comment

joshua-cogliati-inl left a comment

Choose a reason for hiding this comment

joshua-cogliati-inl left a comment

Choose a reason for hiding this comment

dylanjm left a comment

Choose a reason for hiding this comment

dylanjm left a comment

Choose a reason for hiding this comment