Update README.md

README.md

@@ -18,25 +18,23 @@ devtools::install_git(url = "https://forgemia.inra.fr/urfm/sureau.git", ref = "m
 
 # Getting started 
 
-# 1/ install the version you need with devtools
+1/install the version you need with devtools
 devtools::install_git(url = "https://forgemia.inra.fr/urfm/sureau.git", ref = "main")
 require(sureau)
 
 
 
-# 2/ stteing the initialization objects
-# running sureau (using runSurEau()) function returns the internal list of variables, which is
-# accessible if the output of the function is assigned to an object
-# You can also store output easier in a permanent file, set to e. g. file.path(getwd(), "example_output.csv")
+2/ stteing the initialization objects running sureau (using runSurEau()) function returns the internal list of variables, which is
+accessible if the output of the function is assigned to an object. You can also store output easier in a permanent file, set to e. g. file.path(getwd(), "example_output.csv")
 
 
-# Set your options, parameters, and boundary conditions
-# you can use :
-# default values using the following example and the change the object. 
-# For plant and soil you can also read files containg your parametrisation
+3/Set your options, parameters, and boundary conditions
+you can use :
+- default values using the following example and the change the object. 
+- For plant and soil you can also read files containg your parametrisation
+
+progress printer slows down the simulation, so if performance is crucial it is recommended to set printProg=FALSE
 
-# progress printer slows down the simulation, so if performance is crucial
-# it is recommended to set printProg=FALSE
 sim_opt <- create.modeling.options(printProg = TRUE,
                                    #transpirationModel = "Granier",
                                    lat = 48.73, lon = 6.23,
@@ -47,27 +45,30 @@ sim_opt <- create.modeling.options(printProg = TRUE,
                                    outputPath = NULL)
 
 
-par_soil <- create.soil.parameters() 
+par_soil <- create.soil.parameters()
+
 par_veg <- create.vegetation.parameters()
 
 
-# For meteo you need to create a path to the file (here an example file)
+For meteo you need to create a path to the file (here an example file)
+
 climateData_path <- example_fpath("climate_example.csv")
 dat_meteo <- create.climate.data(filePath = climateData_path,
                                  modeling_options = sim_opt)
 
 
-# Initialize the model objects 
+Initialize the model objects 
+
 myModel <- initSurEau(opt = sim_opt, parSoil = par_soil, parPlant = par_veg,
                       datMeteo = dat_meteo)
 myModel$printDiagnostics()
 
-# 3/ --- run model
+3/ --- run model
 
 results <- runSurEau(x = myModel,
                      deepWater = FALSE) # Test GR
 
-# 4/ format the results
+4/ format the results
 results_Formatted = sureau:::convertWB2DF(results)