User guide to the Softgoal Simulation Tool

To run a sample softgoal graph simulation:
• install prolog (Prolog can be downloaded at www.swi-prolog.org )
• open score.pl; remove the % at line

  % :- [combine1, cost1]  

• run plwin
• change current directory to where the softgoal simulation tool is installed by typing at the command prompt:

  > cd('c:/my_directory/'). 

• load main.pl by typing at command prompt:

  > [main]. 

• load defs/arch_def.pl, defs/arch_def.pl by typing at command prompt:

  > [defs/arch_def, defs/arch_def_utils]. 

• perform one run of graph walk by typing at the command prompt:

  > go(goodness of system).  

• perform 10000 run of graph walk and obtain necessary datafile for TAR2 by typing:

  > tar2(arch_def). 

To run TAR2 with the generated datafiles:
• install TAR2 (TAR2 can be downloaded at http://www.ece.ubc.ca/twiki/bin/view/Softeng/TreatmentLearner )
• modify arch_def.names files for the desired class rankings and parameters. For sample .names file configuration see sample_arch_def.names. (rename sample_arch_def.names to arch_def.names)
• make sure that arch_def.cfg exists under the folder tar2. This file is needed for TAR2 classification.
• make sure that the newly generated datafile arch_def.data exists under the folder tar2.
• at dos prompt, type:

  > tar2 arch_def > arch_def.out

  
  for tar2 recommendations according to the class ranking as defined at the arch_def.names file.
• for reversed ranking, type:

  > tar2 -r arch_def > arch_def_r.out

• to perform 10 cross validation, type:

  > xval tar2 arch_def 10

  
  and open the Xdfsum file for result

Setup:
• Softgoal Framework Declaration

  User needs to provide a textual softgoal framework definition file in a special format to be fed to the interpreter. Sample framework definition file can be found under the defs folder.

  Softgoals, claims, and stakeholders can be seen as nodes within the softgoal graph, and should be defined as follows:
  

  softgoal coherence of system is critical. 
  softgoal deletability of system is veryCritical. 
  
  claims c1.  
  claims 'do not exceed space limit'.  
  
  stakeholder eliza.  
  stakeholder rule1.
  

  Rules can be viewed as the edges in the softgoal graph, and are defined in the following manner:
  

  eliza says goodness of system if
    modifiability of system
    any_of  comprehensibility of system
    ref "L Chung's book" keywords [chung].  
    
  rule1 says performance of system if
    helped by c1
    any_of modifiability of process
    any_of modifiability of dataRep
    any_of modifiability of function
    ref "L Chung's book" keywords [chung].  
  

  Note that there must be only one softgoal sitting at the top of the softgoal graph.
• Logic Combination and Cost Scoring Rules

  User is required to customize the scoring function of the softgoal graph. Sample scoring functions for combination rules and costs can be found in the defs_score folder.

• Class Declaration for TAR2

  The names and number of desired classes is defined in a util files associated with the softgoal graph. Sample utils files can be found under the defs folder.

Running the tool:
• install prolog (Prolog can be downloaded at www.swi-prolog.org )
• open score.pl; add the following line:

  :-  [your_directory/your_cost_file, your_directory/your_combine_file].  
  

• run plwin
• change current directory to where the softgoal simulation tool is installed by typing at the command prompt:

  > cd('c:/my_directory/').  
  

• load main.pl by typing at command prompt:

  > [main]. 
  

• load the softgoal graph definition file and the utils file by typing

  > [your_directory/graph_def, your_directory/graph_def_utils]. 
  

• perform one run of graph walk by typing at the command prompt:

  > go(the name of the top softgoal).  
  

• to perform 10000 run of graph walk and obtain necessary datafile for TAR2, type:

  > tar2_write_name_file('the_name_of_your_graph'), 
  make_results(the name of the top softgoal, 10000, 'the_name_of_your_graph'), 
  tar2_analyse_pl('the_name_of_your_graph'), 
  tar2_write_data_file('the_name_of_your_graph').