Commit 76dcacec6ea754deac87477274bc085ff6ba82bc

Authored by Eduardo Eloy
1 parent ee924d62
Exists in Standardized

readme

Showing 1 changed file with 77 additions and 4 deletions   Show diff stats
@@ -30,8 +30,11 @@ Each of these External IDs have an Internal ID which corresponds to the index of @@ -30,8 +30,11 @@ Each of these External IDs have an Internal ID which corresponds to the index of
30 ........................EXAMPLE: 30 ........................EXAMPLE:
31 31
32 30 32 30
  33 +
33 201 34 201
  35 +
34 333 36 333
  37 +
35 335 38 335
36 39
37 ......................... 40 .........................
@@ -52,36 +55,68 @@ So they have the following Internal IDs @@ -52,36 +55,68 @@ So they have the following Internal IDs
52 ### This file sets up the area of each MU. 55 ### This file sets up the area of each MU.
53 56
54 -----------------Example: 57 -----------------Example:
  58 +
55 42.60178 59 42.60178
  60 +
56 8.26 61 8.26
  62 +
57 6.0315 63 6.0315
  64 +
58 26.94 65 26.94
  66 +
59 ------------------------ 67 ------------------------
60 68
61 ## adj_init.txt 69 ## adj_init.txt
62 ### This file sets up the adjacencies of each MU each line should list the Internal IDs of the MUs adjacent to the respective MU separated by a comma. If the MU has no adjacent MUs the line should just have a -1 70 ### This file sets up the adjacencies of each MU each line should list the Internal IDs of the MUs adjacent to the respective MU separated by a comma. If the MU has no adjacent MUs the line should just have a -1
63 71
64 -----------------Example: 72 -----------------Example:
  73 +
65 1,2 74 1,2
  75 +
66 0 76 0
  77 +
67 0 78 0
  79 +
68 -1 80 -1
  81 +
69 ------------------------ 82 ------------------------
  83 +
70 So this forest might look like this: 84 So this forest might look like this:
71 -Internal Ids: External Ids:  
72 -|2| |2|  
73 -|0| |3| |0| |3|  
74 -|1| |1| 85 +
  86 +Internal Ids:
  87 +
  88 +|2|
  89 +
  90 +|0| |3|
  91 +
  92 +|1|
  93 +
  94 +External Ids:
  95 +
  96 +|333|
  97 +
  98 + |
  99 +
  100 +|30| |335|
  101 +
  102 + |
  103 +
  104 +|201|
75 105
76 106
77 ##border_init.txt 107 ##border_init.txt
78 ### This file sets up the lenght of the border of each adjacent MU, each line should list the lenght of the borders of each adjacency separated by a comma. If the MU has no adjacent MUs the should just have a -1 108 ### This file sets up the lenght of the border of each adjacent MU, each line should list the lenght of the borders of each adjacency separated by a comma. If the MU has no adjacent MUs the should just have a -1
79 109
80 -----------------Example: 110 -----------------Example:
  111 +
81 259,151 112 259,151
  113 +
82 490 114 490
  115 +
83 102,653 116 102,653
  117 +
84 -1 118 -1
  119 +
85 ------------------------ 120 ------------------------
86 121
87 If borders aren't a factor is your data just put use 0s in place of real border values 122 If borders aren't a factor is your data just put use 0s in place of real border values
@@ -91,10 +126,15 @@ If borders aren't a factor is your data just put use 0s in place of real border @@ -91,10 +126,15 @@ If borders aren't a factor is your data just put use 0s in place of real border
91 ### This file sets up the Prescriptions associated with each MU, each line should list the IDs of the Prescriptions associated with each MU 126 ### This file sets up the Prescriptions associated with each MU, each line should list the IDs of the Prescriptions associated with each MU
92 127
93 -----------------Example: 128 -----------------Example:
  129 +
94 1,2,3 130 1,2,3
  131 +
95 19 132 19
  133 +
96 19,20,21 134 19,20,21
  135 +
97 500,501,502,503,500600,500601 136 500,501,502,503,500600,500601
  137 +
98 ------------------------ 138 ------------------------
99 139
100 ##years_init.txt 140 ##years_init.txt
@@ -104,10 +144,15 @@ If borders aren't a factor is your data just put use 0s in place of real border @@ -104,10 +144,15 @@ If borders aren't a factor is your data just put use 0s in place of real border
104 Before listing the years the line should have the Internal ID of the MU followed by a "|" 144 Before listing the years the line should have the Internal ID of the MU followed by a "|"
105 145
106 -----------------Example: 146 -----------------Example:
  147 +
107 0|2026,2056,2066/2027,2049,2060/2028,2040,2052,2064 148 0|2026,2056,2066/2027,2049,2060/2028,2040,2052,2064
  149 +
108 1|2022,2032,2042 150 1|2022,2032,2042
  151 +
109 2|2026,2046/2060/-1 152 2|2026,2046/2060/-1
  153 +
110 3|2052/2057/-1/2067/2052/2052 154 3|2052/2057/-1/2067/2052/2052
  155 +
111 ------------------------ 156 ------------------------
112 157
113 #Step 2: Criteria Files 158 #Step 2: Criteria Files
@@ -115,16 +160,23 @@ Before listing the years the line should have the Internal ID of the MU followed @@ -115,16 +160,23 @@ Before listing the years the line should have the Internal ID of the MU followed
115 There can be a maximum of 10 optimizable criteria in the program represented by these files, these files are crit_file0-10.txt and their format is the same. 160 There can be a maximum of 10 optimizable criteria in the program represented by these files, these files are crit_file0-10.txt and their format is the same.
116 161
117 Each line corresponds to an MU similarly to previous files and the contents are separated by commas, the contents are the values of the objective criteria associated with each Prescription of the respective MU 162 Each line corresponds to an MU similarly to previous files and the contents are separated by commas, the contents are the values of the objective criteria associated with each Prescription of the respective MU
  163 +
118 -----------------Example: 164 -----------------Example:
  165 +
119 34,30.99,3.363 166 34,30.99,3.363
  167 +
120 1568.630 168 1568.630
  169 +
121 565.79,146,1692 170 565.79,146,1692
  171 +
122 4966,6310,7,87,49,496 172 4966,6310,7,87,49,496
  173 +
123 ------------------------ 174 ------------------------
124 175
125 #Step 3: Running the software 176 #Step 3: Running the software
126 177
127 The program is run through the make file and requires Java 11. 178 The program is run through the make file and requires Java 11.
  179 +
128 Open up the Makefile in this folder and modify the parameters of the "make" label, then run the "make" command in the terminal. 180 Open up the Makefile in this folder and modify the parameters of the "make" label, then run the "make" command in the terminal.
129 181
130 ## MainWithSpecific 182 ## MainWithSpecific
@@ -134,22 +186,38 @@ The examples shown are related to the Vale de Sousa forest which was used in the @@ -134,22 +186,38 @@ The examples shown are related to the Vale de Sousa forest which was used in the
134 186
135 ## MainWithSpecific parameters: 187 ## MainWithSpecific parameters:
136 1st- Maximum Area Limit (50) 188 1st- Maximum Area Limit (50)
  189 +
137 2nd- Directory with data about forest (res) 190 2nd- Directory with data about forest (res)
  191 +
138 3rd- Minimum Border Lenght (50) 192 3rd- Minimum Border Lenght (50)
  193 +
139 4th- Single or Multi Criteria 194 4th- Single or Multi Criteria
  195 +
140 5th- Name of file with the UGs to be considered (in subregions folder) 196 5th- Name of file with the UGs to be considered (in subregions folder)
  197 +
141 6th and onward- Choose the criterias to be optimized, if the 4th parameter is Single only the first criteria will be optimized 198 6th and onward- Choose the criterias to be optimized, if the 4th parameter is Single only the first criteria will be optimized
142 199
  200 +
143 0-Criteria0 (Wood Yield) 201 0-Criteria0 (Wood Yield)
  202 +
144 1-Criteria1 (Soil Loss) 203 1-Criteria1 (Soil Loss)
  204 +
145 2-Criteria2 (Perc_r) 205 2-Criteria2 (Perc_r)
  206 +
146 3-Criteria3 (Biodiversity) 207 3-Criteria3 (Biodiversity)
  208 +
147 4-Criteria4 (Cashflow) 209 4-Criteria4 (Cashflow)
  210 +
148 5-Criteria5 (Carbon Stock) 211 5-Criteria5 (Carbon Stock)
  212 +
149 6-Criteria6 (NPV) 213 6-Criteria6 (NPV)
  214 +
150 7-Criteria7 (Perc_rait) 215 7-Criteria7 (Perc_rait)
  216 +
151 8-Criteria8 (R) 217 8-Criteria8 (R)
  218 +
152 9-Criteria9 (Rait) 219 9-Criteria9 (Rait)
  220 +
153 10-Criteria10(Sbiom) 221 10-Criteria10(Sbiom)
154 222
155 ## Example to optimize Wood Yield and Soil Loss in Paredes-> MainWithSpecific 50 res 50 Multi Paredes 0 1 223 ## Example to optimize Wood Yield and Soil Loss in Paredes-> MainWithSpecific 50 res 50 Multi Paredes 0 1
@@ -164,13 +232,18 @@ Example: MainTime 50 res 50 28800000 Paredes 0 1 @@ -164,13 +232,18 @@ Example: MainTime 50 res 50 28800000 Paredes 0 1
164 232
165 #Step 4: Output files 233 #Step 4: Output files
166 In Multi Criteria optimization the following files are written to the Results folder: 234 In Multi Criteria optimization the following files are written to the Results folder:
  235 +
167 Output files Multi-Criteria: 236 Output files Multi-Criteria:
168 237
169 238
170 allSolutionPairs.csv:- MU/Presc pairs for every valid solution found 239 allSolutionPairs.csv:- MU/Presc pairs for every valid solution found
  240 +
171 outputPairsMulti.csv:- MU/Presc pairs for every pareto solution (determined by choco solver) 241 outputPairsMulti.csv:- MU/Presc pairs for every pareto solution (determined by choco solver)
  242 +
172 nonPareto.csv:- Values of the optimizable criteria for every valid solution found 243 nonPareto.csv:- Values of the optimizable criteria for every valid solution found
  244 +
173 pareto.csv:- Values of the optimizable criteria for every pareto solution found 245 pareto.csv:- Values of the optimizable criteria for every pareto solution found
  246 +
174 pairCriteria.csv:- MU/Presc pairs for every pareto solution along with associated values of objective criteria. 247 pairCriteria.csv:- MU/Presc pairs for every pareto solution along with associated values of objective criteria.
175 248
176 249