raarellano/doc.md

## doc.md

      
    Raw
  

              doc.md
            
          
    Python-SPSS Scripting

The following documentation provides samples and instructions on how to get a Python script working with SPSS.
Standalone Scripts

Scripts can be ran outside of the SPSS GUI through the command prompt by using Modeler Batch/Clemb. Standalone scripts can  also be ran through the SPSS GUI using standalone script. Tools > Standalone Script
Running a script using Clemb

Modeler Batch or Clemb is included with Modeler Client. It is not a separate install. If you have Modeler client you can use the clemb.exe that is in the bin folder and run against the local server.  You can find the executable here:
<path to spss program directory>\Modeler\18.0\bin\clemb.exe
Python scripts can be be executed through clemb. Clemb/Modeler Batch allows users to run SPSS Modeler from a command line, without the need of a graphical user interface.
Clemb has a variety of options and configurations which can be referenced in “IBM SPSS Modeler 18 Batch Users’s Guide”.
Here is a sample clemb command (with paramaters) that will execute the attached sample python script.
C:\"Program Files"\IBM\SPSS\Modeler\18.0\bin\clemb 
-script C:\Users\Administrator\Desktop\DEVELOP\spss_scripting\ModelerScript.py 
-Pcity=Austin 
-execute

Sample Python Script

The following is sample script that runs a specific SPSS file (stream) and specific nodes for testing purposes. The script can be ran through SPSS GUI as a standalone script or using the command line using clemb.
The script takes in a session argument through clemb. This argument is optional.
Resources


http://www-01.ibm.com/support/docview.wss?uid=swg21686375


http://www-01.ibm.com/support/docview.wss?uid=swg21616349


http://www.sv-europe.com/blog/writing-standalone-python-script-modeler/


ftp://public.dhe.ibm.com/software/analytics/spss/documentation/modeler/16.0/en/modeler_jython_scripting_automation_book.pdf


ftp://public.dhe.ibm.com/software/analytics/spss/documentation/modeler/18.0/en/ModelerBatch.pdf


## sample_spsss_python_script.py
def initSession():
	return modeler.script.session()

def initStream(session, streamFile):
	taskrunner = session.getTaskRunner()
	return openStream(taskrunner, streamFile)

def openStream(taskrunner, streamFile):
	try:
		stream = taskrunner.openStreamFromFile(streamFile, True)
	except:
	    print "Could not open", streamFile
	    modeler.script.exit(1)

	return stream

def getCity(session):
	city = session.getParameterValue('city')

	if city == None:
		city = "Dallas"

	print city
	return city

def runAnalysis(city):
	results = []

	if city == "Dallas":
		stream.findByID("id552TFW5PVMW").run(results)
	elif city == "Austin":
		stream.findByID("id4FYTFKPRGES").run(results)

	printResults(results)
	# return results

def runExportResults(city):
	results = []

	if city == "Dallas":
		stream.findByID("id2JESUGKSLIB").run(results)
		# Exports file Dallas Cl1NN
	elif city == "Austin":
		stream.findByID("id56YT3B2IWXX").run(results)
		# Exports file Austin Cl1NN

	print "Excel Exported"


def printResults(results):
	print "Results"
	print results[0]

# Define Stream File
streamFile = "C:\Users\Administrator\Desktop\DEVELOP\spss_scripting\example_stream.str"

# Start SPSS Session
session = initSession()
stream = initStream(session, streamFile)

# Get Params
city = getCity(session)

# Run Nodes
# runAnalysis(city)
runExportResults(city)
	def initSession():
	return modeler.script.session()

	def initStream(session, streamFile):
	taskrunner = session.getTaskRunner()
	return openStream(taskrunner, streamFile)

	def openStream(taskrunner, streamFile):
	try:
	stream = taskrunner.openStreamFromFile(streamFile, True)
	except:
	print "Could not open", streamFile
	modeler.script.exit(1)

	return stream

	def getCity(session):
	city = session.getParameterValue('city')

	if city == None:
	city = "Dallas"

	print city
	return city

	def runAnalysis(city):
	results = []

	if city == "Dallas":
	stream.findByID("id552TFW5PVMW").run(results)
	elif city == "Austin":
	stream.findByID("id4FYTFKPRGES").run(results)

	printResults(results)
	# return results

	def runExportResults(city):
	results = []

	if city == "Dallas":
	stream.findByID("id2JESUGKSLIB").run(results)
	# Exports file Dallas Cl1NN
	elif city == "Austin":
	stream.findByID("id56YT3B2IWXX").run(results)
	# Exports file Austin Cl1NN

	print "Excel Exported"


	def printResults(results):
	print "Results"
	print results[0]

	# Define Stream File
	streamFile = "C:\Users\Administrator\Desktop\DEVELOP\spss_scripting\example_stream.str"

	# Start SPSS Session
	session = initSession()
	stream = initStream(session, streamFile)

	# Get Params
	city = getCity(session)

	# Run Nodes
	# runAnalysis(city)
	runExportResults(city)