readme

Eduardo Eloy
1 parent 3e058fbe
Showing 1 changed file with 117 additions and 22 deletions Show diff stats
MODFIRE-Prototype/README.md
 # Forest Management
 The purpose of this implementation is to use Constraint Programming to find valid solutions for problems of forest management.
+
 Here, Management Units (MUs) are associated with possible prescriptions which define which years the MUs are to be harvested.
+
 But in any given year only 50ha of contiguous forest area can be harvested at once.
 Therefore the implementation needs input defining:
 1-The existing MUs in the forest
+
 2-The area of each MU
+
 3-The MUs adjacent to each MU
+
 4-The border lenght of each adjacency between MUs
+
 5-The IDs of the Prescriptions of each MU
+
 6-Relative to each Prescription, the years where the Prescription defines that the MU should be harvested.
+
 7-Relative to each Prescription, the rewards each Prescription gives for being applied.
-# Step 1: Necessary Setup Files
+# Step 1: Necessary Setup Files.
 In general for every line in one of the files we assume a new Management Unit, a file with 4 lines would imply that there are 4 MUs, and since this has to be consistent then that means all input files should have 4 lines.
@@ -23,102 +31,168 @@ In general for every line in one of the files we assume a new Management Unit, a
 ## external_init.txt 
-###- This file serves to indicate how many Management Units exist in the forest, so each line should have a number to serve as an External identifier of each MU. There should be as many lines as there are MUs in the forest
+### This file serves to indicate how many Management Units exist in the forest, so each line should have a number to serve as an External identifier of each MU. There should be as many lines as there are MUs in the forest.
 Each of these External IDs have an Internal ID which corresponds to the index of their row starting from 0
------------------EXAMPLE:
+
+........................EXAMPLE:
+
 30
+
 201
+
 333
+
 335
--------------------------
+
+.........................
 So they have the following Internal IDs
-----------------
+
+.........................
+
 0
+
 1
+
 2
+
 3
-----------------
+
+.........................
 ## area_init.txt 
-###- This file sets up the area of each MU.
+### This file sets up the area of each MU.
 -----------------Example:
+
 42.60178
+
 8.26
+
 6.0315
+
 26.94
+
 ------------------------
 ## adj_init.txt 
-###- 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
+### 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
 -----------------Example:
+
 1,2
+
 0
+
 0
+
 -1
+
 ------------------------
+
 So this forest might look like this:
-Internal Ids:			External Ids:
-|2|                           |2|
-|0|  |3|                      |0|  |3|
-|1|                           |1|
+Internal Ids:
+
+|2|
+
+ |
-##border_init.txt 
-###- 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
+|0|  |3|
+
+ |
+ 
+|1|
+
+External Ids:
+
+|333|
+ 
+ |
+
+|30|     |335|
+
+ |
+
+|201|
+
+
+## border_init.txt 
+### 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
 -----------------Example:
+
 259,151
+
 490
+
 102,653
+
 -1
+
 ------------------------
 If borders aren't a factor is your data just put use 0s in place of real border values
-##ugs_init.txt 
-###- This file sets up the Prescriptions associated with each MU, each line should list the IDs of the Prescriptions associated with each MU
+## ugs_init.txt 
+### This file sets up the Prescriptions associated with each MU, each line should list the IDs of the Prescriptions associated with each MU
 -----------------Example:
+
 1,2,3
+
 19
+
 19,20,21
+
 500,501,502,503,500600,500601
+
 ------------------------
-##years_init.txt 
-###- This file sets up the relation between Prescriptions and the years where those Prescriptions have Harvest actions. 
+## years_init.txt 
+### This file sets up the relation between Prescriptions and the years where those Prescriptions have Harvest actions. 
+
 ### Each line lists the years where the corresponding Prescription has Harvest actions separated by commas, if the MU has more than one Prescription then a "/" is followed by the next Prescription's harvest years. If a Prescription has no years of Harvest there should be a -1
 Before listing the years the line should have the Internal ID of the MU followed by a "|"
  -----------------Example:
+
 0|2026,2056,2066/2027,2049,2060/2028,2040,2052,2064
+
 1|2022,2032,2042
+
 2|2026,2046/2060/-1
+
 3|2052/2057/-1/2067/2052/2052
+
 ------------------------
-#Step 2: Criteria Files
+# Step 2: Criteria Files
 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.
 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
+
 -----------------Example:
+
 34,30.99,3.363
+
 1568.630
+
 565.79,146,1692
+
 4966,6310,7,87,49,496
+
 ------------------------
-#Step 3: Running the software
+# Step 3: Running the software
 The program is run through the make file and requires Java 11.
+
 Open up the Makefile in this folder and modify the parameters of the "make" label, then run the "make" command in the terminal.
 ## MainWithSpecific
@@ -128,25 +202,41 @@ The examples shown are related to the Vale de Sousa forest which was used in the
 ## MainWithSpecific parameters:
 1st- Maximum Area Limit (50)
+
 2nd- Directory with data about forest (res)
+
 3rd- Minimum Border Lenght (50)
+
 4th- Single or Multi Criteria
+
 5th- Name of file with the UGs to be considered (in subregions folder)
+
 6th and onward- Choose the criterias to be optimized, if the 4th parameter is Single only the first criteria will be optimized
+
 0-Criteria0 (Wood Yield)
+
 1-Criteria1 (Soil Loss)
+
 2-Criteria2 (Perc_r)
+
 3-Criteria3 (Biodiversity)
+
 4-Criteria4 (Cashflow)
+
 5-Criteria5 (Carbon Stock)
+
 6-Criteria6 (NPV)
+
 7-Criteria7 (Perc_rait)
+
 8-Criteria8 (R)
+
 9-Criteria9 (Rait)
+
 10-Criteria10(Sbiom)
-## Example to optimize Wood Yield and Soil Loss in Paredes-> MainWithSpecific 50 res 50 Multi Paredes 0 1
+#### Example to optimize Wood Yield and Soil Loss in Paredes-> MainWithSpecific 50 res 50 Multi Paredes 0 1
 The program will try to find valid solutions for 8 hours (28800000 miliseconds) or until there's a memory error.
@@ -156,15 +246,20 @@ Same as MainWithSpecific but the 4th parameter sets the time limit for finding s
 Example: MainTime 50 res 50 28800000 Paredes 0 1
-#Step 4: Output files
+# Step 4: Output files
 In Multi Criteria optimization the following files are written to the Results folder:
+
 Output files Multi-Criteria:
 allSolutionPairs.csv:- MU/Presc pairs for every valid solution found 
+
 outputPairsMulti.csv:- MU/Presc pairs for every pareto solution (determined by choco solver)
+
 nonPareto.csv:- Values of the optimizable criteria for every valid solution found 
+
 pareto.csv:- Values of the optimizable criteria for every pareto solution found 
+
 pairCriteria.csv:- MU/Presc pairs for every pareto solution along with associated values of objective criteria.