
README-VASC
-----------------------
Version 09.28.11.a
Matthew Fitzgerald

-----------------------
System Requirement:
----------------------- 
MATLAB(R) (software developed with version 2010a, 2010b, 2011a on Windows 7 PC)

-----------------------
Supporting documentation: 
-----------------------
1. METAII-SoftwareDescription.pdf: high level description of software
2. METAII-TechAppendix.pdf: techincal description of approach and metrics in software
3. METAII-SpaceTug-demo.pdf: demo presentation of SpaceTug case results

-----------------------
Basic instructions for Space Tug:
-----------------------
1. in Space Tug directory, run the script "RunMeFirst"
2. run one of the scripts in the Demo Scripts folder for a full analysis of one strategy
* THIS WILL TAKE A FEW HOURS: REDUCE THE NUMBER OF ERAS PER DESIGN IF YOU DESIRE FASTER BUT LESS ACCURATE RESULTS *
3. for manual analysis, run the dataLoader function and manipulate the case data as you want

-----------------------
Basic instructions for X-TOS:
-----------------------
* FIRST TIME ONLY *
1. in X-TOS directory, run the script "RunMeFirst"
2. Load Tijkfixed.mat
3. Create collapsed transition matrices using ruleCollapse2.m
	default: [allRulePaths allDesignPaths allCostPaths savetime] = 							ruleCollapse2(Tcost,Ttime,1,2,0,0)
	* This will take ~1 day to run and requires a computer with a 		substantial amount of RAM (~20GB)
	* Can also reduce the 4th argument to 1 to save time by 		considering only single-arc transitions
	* Will automatically save RuleCollapseFinalOutput.mat

* ALL SUCCESSIVE TIMES *
1. in X-TOS directory, run the script "RunMeFirst"
2. run demoLoad.m
3a. For example start-to-finish analysis of a strategy, run one 	of the Demo Scripts (MaxEfficiency.m or MaxUtility.m)
3b. For manual analysis, the workspace should be loaded and 	ready to go by Step 2.  To save time, you may consider 	loading one of the Strategy Pre-runs saved in the Data and 	Data Loaders subfolder.

-----------------------
Contents
-----------------------
The software included in this package includes the following files and folders:

METAII-TechAppendix.pdf
METAII-SoftwareDescription.pdf
METAII-SpaceTug-demo.pdf
license.txt
README-VASC.txt
->Space Tug
	RunMeFirst.m
	->Utility
		SpaceTugMAUcalc.m
		baseCaseMAUandSAU.mat
	->Strategies
		STRATcollapsed_survive.m
		STRATcollapsed_maxU.m
		STRATcollapsed_maxEff.m
	->Helper Functions
		transitionAnalysis.m
		ruleExecutionCounter.m
		ruleCollapse2.m
		gen_pareto_set.m
		FPSdistrPlot.m
		designPathTool.m
		cellSpy.m
		calcFuzzyParetoNumbers.m
		calcFPS.m
		calcFOD.m
		calcEffFPV.m
		bestParetoTraceFinder.m
	->Era Simulation
		ERA_spaceTug_survive.m
		ERA_spaceTug_maxU.m
		ERA_spaceTug_maxProfit.m
		ERA_spaceTug_maxEff.m
	->Demo Scripts
		Survive.m
		MaximizeUtility.m
		MaximizeProfit.m
		MaximizeEfficiency.m
	->Data and Data Loaders
		->Code Runs
			July12-allDesigns5000erasMAXU.mat
			July6-allDesigns5000erasMAXPROF.mat
			June29-allDesigns5000erasMAXEFF.mat
			June27-allDesigns5000erasSURVIVE.mat
		SpaceTugTransMatrixGenerator.m
		designCalculator.m
		dataLoader.m
		spaceTug_transMatrices.mat
		spaceTugCollapsedTransitions.mat
		spaceTugPrefSets.mat
		spaceTugEpochPrefs.xls
		tradespaceData.csv
->X-TOS
	RunMeFirst.m
	-> Strategies
		STRATcollapsed_maxEff.m
		STRATcollapsed_maxU.m
	-> Helper Functions
		transitionAnalysis.m
		ruleLikelihood.m
		ruleExecutionCounter.m
		ruleCollapse2.m
		plotFOD.m
		plotFNPT.m
		gen_pareto_set.m
		FPSdistrPlot.m
		designPathTool.m
		cellSpy.m
		calcFuzzyParetoNumbers.m
		calcFPS.m
		calcFOD.m
		calcEffFPV.m
		bestParetoTraceFinder.m
	-> Era Modeling
		eraSim_geometricDuration.m
		eraSim_poissonDuration.m
		eraSim_random.m
	-> Demo Scripts
		demoLoad.m
		MaxEfficiency.m
		MaxUtility.m
	-> Data and Data Loaders
		-> Strat pre-runs
			EffEra.mat
			EffEraNOREDESIGN.mat
			MaxEffOut.mat
			MaxEffOutNOREDESIGN.mat
			MaxUOut.mat
			MaxUOutNOREDESIGN.mat
			UtilEra.mat
			UtilEraNOREDESIGN.mat
		dataLoader.m
		DMExp1a.mat
		DMExp1b.mat
		DMExp1c.mat
		DMExp1d.mat
		MAU_COST_DV.csv
		MAU_COST_DV.mat
		setup_MATE.m
		Tijkfixed.mat
		xtos_dataset1b.csv
		XTOS-FPN.mat