Publish as EXE - Introduction

[tobin]

Available starting R3 Beta 2

Publishing your simulation as an executable is a new bundled feature that “compiles” your simulation—including all scripts and resource files—into a single .EXE package. The compiled package will work as a fully functional Vizard development environment with the notable difference being that it can run on any machine now without installing Vizard first. There is a restriction, though; “compiled” simulations cannot be edited or modified (i.e., scripts or resource files changed) without recompiling on a licensed Vizard development machine.

Accessing and using this feature is easy as it’s built into the Vizard development environment. Under the file menu, you’ll now find “Publish as EXE…”. A Wizard will walk you through the necessary steps. The compiler has two steps; the first requires that you run your script so that all dependencies (across your project files, Vizard modules, Python, etc) can be identified. Second, it compresses everything together into a single EXE that can be distributed royalty-free.

Other limitations:

• Published EXEs are unable to generate AVI recordings by the user pressing F12.
• Published EXEs from Trial/Lite editions will self-exit after 2 minute (Beta 2 can be activated as a full Development edition and so it’s published EXEs will not have this restriction)
• Published EXEs cannot server as members in a cluster.

[tobin]

If you attempt to run a R3 published EXE on a machine that has had R2 installed but never R3 installed, then the EXE will not function correctly and will produce a number of errors. R2 unfortunately defined itself in the system path and this collides with R3. The R3 installer removes this entry from the system path.

To remedy this, either install R3 Beta or manually remove "c:\program files\vizard25" from you system's PATH environment variable.

[cade_mccall]

Hi-

We've tried publishing as EXE on a couple computers and we can't seem to get it to work (even with a bare-bones script). I get to the point of running the program within the Publish as EXE dialogue box but then when I close the script, the process fails. The two computers I've tried this on have 2.53 on them, if that matters.

-Cade

[mspusch]

Hi Cade,

are you sure that either R3 is installed and/or "c:\program files\vizard25" is removed from you system's PATH environment variable?
Please have a look at the previous post and the implications of an R2 installation on running an executable on a computer. Hope this helps.

[cade_mccall]

Hi-

I want the exe I've made with Publish to EXE to write to a text file for recording data. Is that possible?

Thanks,
Cade

[farshizzo]

Yes, it should be possible. Did you have a problem trying it?

[cade_mccall]

No. When I publish this script as an exe . . .

import viz
viz.go()
file = open( 'test.txt', 'a' )
file.write( 'hello' )
file.close()

. . . I can't get the exe to write anything.

[farshizzo]

Keep in mind that published EXEs are extracted to a temporary directory then executed from there. So the file is probably being created in that temp directory, which gets deleted after your script exits. I'm assuming you want the file to be created in the same directory as the EXE? Here is sample code that does this:

import viz
viz.go()

#Get path to publish EXE
path = viz.getOption('viz.publish.path','.')+'/'

#Open file in path
file = open( path + 'test.txt', 'a' )
file.write( 'hello' )
file.close()

[cade_mccall]

Perfect. Thanks.

[TrashcanPatrol]

I'm having the same problem... I tried what you said and it works for when I'm running the script inside Vizard, but not when I'm running it as a published EXE. It creates instead a blank document named whatever I named it... am I doing something wrong?

[Jeff]

This happened when you published the short script posted here?

[TrashcanPatrol]

Hmm it works when I try to run just the script posted here... just not when I try to put it into my own script

[moooh]

I'm just going to slide into this conversation and add my problem with publishing instead of making a new topic.

I'm using the module xml.dom.minidom but when I publish an exe and try to run it on an other computer, the exe is unable to find this module. The publish as exe wizard found a dependancy for minicompat.pyc but having it included does not change anything.

I noticed that the minidom.py didn't have it's own .pyc file so I tried manually compiling one and included in the list of dependencies. This didn't change anything either.

Being fairly new to Python I'm not entirely sure how the structuring works for the .pyc-files.
The minidom is importing other modules from the xml.dom namespace, do I need to create .pyc files for all of those as well? Or are they recursively bundled toghether inside the minidom.pyc?

[farshizzo]

Using the xml.dom.minidom module in a published exe works fine for me. Can you publish the following script to an exe?

import viz
viz.go()

import xml.dom.minidom

[moooh]

No that one fails as well.

Traceback (most recent call last):
  File "<string>", line 11, in ?
  File "testfile.py", line 4, in ?
      import xml.dom.minidom
ImportError: No module named xml.dom.minidom

Note that this is on a computer which do not have neither Python nor Vizard installed. If I publish the same exe and run it from my own system which has Vizard, the exe finds the module. Presumably it also fails to find it in the exe in that case, but has the option of looking up and finding it elsewhere.

[moooh]

Found out anything regarding this?
The dependencies I get when publishing the 3 line script is the following:

viz_python.dll
python24.dll
osgDB.dll
MSVCP71.dll
osg.dll
osgText.dll
osgParticle.dll
MSVCR71.dll
vizcore.dll
Producer.dll
OpenThreadsWin32.dll
transform.dll
osgUtil.dll
codecs.pyc
minidom.pyc
sre_parse.pyc
HTMLDOMImplementation.pyc
traceback.pyc
domreg.pyc
MessageSource.pyc
__init__.pyc
Range.pyc
viz.pyc
dis.pyc
UserDict.pyc
sre_constants.pyc
token.pyc
__init__.pyc
re.pyc
types.pyc
sre_compile.pyc
linecache.pyc
testfile.py
random.pyc
cp1252.pyc
tokenize.pyc
xmlbuilder.pyc
gettext.pyc
stat.pyc
sre.pyc
locale.pyc
vizmat.pyc
inspect.pyc
site.pyc
FtCore.pyc
__init__.pyc
__init__.pyc
DOMImplementation.pyc
aliases.pyc
NodeFilter.pyc
ntpath.pyc
opcode.pyc
minicompat.pyc
os.pyc
copy_reg.pyc
string.pyc
warnings.pyc
copy.pyc
vizact.pyc

Is this the same list that you get for your exe that is working?

[farshizzo]

You probably have another Python installation on your computer that is interfering with the Vizard installation. Run the following script and post the output. If the output contains any directories that are outside the Vizard directory, then that is most likely the problem.

import sys
for p in sys.path:
	print p

[moooh]

Here's what I get. Seems to be the expected normal result, everything is under Vizard.

C:\Program Files\WorldViz\Vizard30\python
C:\Program Files\WorldViz\Vizard30\bin\python24.zip
C:\Program Files\WorldViz\Vizard30\bin\lib
C:\Program Files\WorldViz\Vizard30\bin\DLLs
C:\Program Files\WorldViz\Vizard30\bin\lib\plat-win
C:\Program Files\WorldViz\Vizard30\bin\lib\lib-tk
C:\Program Files\WorldViz\Vizard30\bin
C:\Program Files\WorldViz\Vizard30\bin\lib\site-packages
C:\Program Files\WorldViz\Vizard30\bin\lib\win32

For some reason I seem to have failed to mention that I'm running Vizard under Windows Vista. That may or may not have anything to do with this problem.

[farshizzo]

In that case you have a corrupted version of Vizard. Some of the files in the list you previously posted are not included with Vizard (MessageSource.py, HTMLDOMImplementation.py, DOMImplementation.py). I would recommend that you uninstall Vizard, delete the entire Vizard directory, then reinstall it. Hopefully this will fix the issue.

[moooh]

A fresh install and the problem is no more. Thanks.