Commit 76dcacec6ea754deac87477274bc085ff6ba82bc
1 parent
ee924d62
Exists in
Standardized
readme
Showing
1 changed file
with
77 additions
and
4 deletions
Show diff stats
README.md
... | ... | @@ -30,8 +30,11 @@ Each of these External IDs have an Internal ID which corresponds to the index of |
30 | 30 | ........................EXAMPLE: |
31 | 31 | |
32 | 32 | 30 |
33 | + | |
33 | 34 | 201 |
35 | + | |
34 | 36 | 333 |
37 | + | |
35 | 38 | 335 |
36 | 39 | |
37 | 40 | ......................... |
... | ... | @@ -52,36 +55,68 @@ So they have the following Internal IDs |
52 | 55 | ### This file sets up the area of each MU. |
53 | 56 | |
54 | 57 | -----------------Example: |
58 | + | |
55 | 59 | 42.60178 |
60 | + | |
56 | 61 | 8.26 |
62 | + | |
57 | 63 | 6.0315 |
64 | + | |
58 | 65 | 26.94 |
66 | + | |
59 | 67 | ------------------------ |
60 | 68 | |
61 | 69 | ## adj_init.txt |
62 | 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 | 72 | -----------------Example: |
73 | + | |
65 | 74 | 1,2 |
75 | + | |
66 | 76 | 0 |
77 | + | |
67 | 78 | 0 |
79 | + | |
68 | 80 | -1 |
81 | + | |
69 | 82 | ------------------------ |
83 | + | |
70 | 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 | 107 | ##border_init.txt |
78 | 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 | 110 | -----------------Example: |
111 | + | |
81 | 112 | 259,151 |
113 | + | |
82 | 114 | 490 |
115 | + | |
83 | 116 | 102,653 |
117 | + | |
84 | 118 | -1 |
119 | + | |
85 | 120 | ------------------------ |
86 | 121 | |
87 | 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 | 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 | 128 | -----------------Example: |
129 | + | |
94 | 130 | 1,2,3 |
131 | + | |
95 | 132 | 19 |
133 | + | |
96 | 134 | 19,20,21 |
135 | + | |
97 | 136 | 500,501,502,503,500600,500601 |
137 | + | |
98 | 138 | ------------------------ |
99 | 139 | |
100 | 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 | 144 | Before listing the years the line should have the Internal ID of the MU followed by a "|" |
105 | 145 | |
106 | 146 | -----------------Example: |
147 | + | |
107 | 148 | 0|2026,2056,2066/2027,2049,2060/2028,2040,2052,2064 |
149 | + | |
108 | 150 | 1|2022,2032,2042 |
151 | + | |
109 | 152 | 2|2026,2046/2060/-1 |
153 | + | |
110 | 154 | 3|2052/2057/-1/2067/2052/2052 |
155 | + | |
111 | 156 | ------------------------ |
112 | 157 | |
113 | 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 | 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 | 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 | 164 | -----------------Example: |
165 | + | |
119 | 166 | 34,30.99,3.363 |
167 | + | |
120 | 168 | 1568.630 |
169 | + | |
121 | 170 | 565.79,146,1692 |
171 | + | |
122 | 172 | 4966,6310,7,87,49,496 |
173 | + | |
123 | 174 | ------------------------ |
124 | 175 | |
125 | 176 | #Step 3: Running the software |
126 | 177 | |
127 | 178 | The program is run through the make file and requires Java 11. |
179 | + | |
128 | 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 | 182 | ## MainWithSpecific |
... | ... | @@ -134,22 +186,38 @@ The examples shown are related to the Vale de Sousa forest which was used in the |
134 | 186 | |
135 | 187 | ## MainWithSpecific parameters: |
136 | 188 | 1st- Maximum Area Limit (50) |
189 | + | |
137 | 190 | 2nd- Directory with data about forest (res) |
191 | + | |
138 | 192 | 3rd- Minimum Border Lenght (50) |
193 | + | |
139 | 194 | 4th- Single or Multi Criteria |
195 | + | |
140 | 196 | 5th- Name of file with the UGs to be considered (in subregions folder) |
197 | + | |
141 | 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 | 201 | 0-Criteria0 (Wood Yield) |
202 | + | |
144 | 203 | 1-Criteria1 (Soil Loss) |
204 | + | |
145 | 205 | 2-Criteria2 (Perc_r) |
206 | + | |
146 | 207 | 3-Criteria3 (Biodiversity) |
208 | + | |
147 | 209 | 4-Criteria4 (Cashflow) |
210 | + | |
148 | 211 | 5-Criteria5 (Carbon Stock) |
212 | + | |
149 | 213 | 6-Criteria6 (NPV) |
214 | + | |
150 | 215 | 7-Criteria7 (Perc_rait) |
216 | + | |
151 | 217 | 8-Criteria8 (R) |
218 | + | |
152 | 219 | 9-Criteria9 (Rait) |
220 | + | |
153 | 221 | 10-Criteria10(Sbiom) |
154 | 222 | |
155 | 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 | 232 | |
165 | 233 | #Step 4: Output files |
166 | 234 | In Multi Criteria optimization the following files are written to the Results folder: |
235 | + | |
167 | 236 | Output files Multi-Criteria: |
168 | 237 | |
169 | 238 | |
170 | 239 | allSolutionPairs.csv:- MU/Presc pairs for every valid solution found |
240 | + | |
171 | 241 | outputPairsMulti.csv:- MU/Presc pairs for every pareto solution (determined by choco solver) |
242 | + | |
172 | 243 | nonPareto.csv:- Values of the optimizable criteria for every valid solution found |
244 | + | |
173 | 245 | pareto.csv:- Values of the optimizable criteria for every pareto solution found |
246 | + | |
174 | 247 | pairCriteria.csv:- MU/Presc pairs for every pareto solution along with associated values of objective criteria. |
175 | 248 | |
176 | 249 | ... | ... |