Update README.md

README.md

@@ -79,22 +79,31 @@ The 'steady_state_simulations' function has the option of running a flow balance
 
 Args:
 - influent_type: Specify whether the influent is constant ('constant') or variable ('variable') over time.
+Args:
+- influent_type: Specify whether the influent is constant ('constant') or variable ('variable') over time.
+
 - influent:
     - If the influent type is constant (DataFrame):
-            Each row corresponds to different influent scenarios to be tested. Columns represent influent characteristics in the same order as in BioWin: ['Flow', 'COD (mg-COD/L)', 'TKN (mg-N/L)', 'TP (mg-P/L)', 'TS (mg-S/L)', 'Nitrate (mg-N/L)', 'pH', 'Alkalinity (mmol/L)', 'ISS total (mg-ISS/L)', 'Metal soluble - Ca (mg/L)', 'Metal soluble - Mg (mg/L)', 'Gas - Dissolved O2 (mg/L)'].
+        Each row corresponds to different influent scenarios to be tested. Columns represent influent characteristics in the same order as in BioWin: ['Flow', 'COD (mg-COD/L)', 'TKN (mg-N/L)', 'TP (mg-P/L)', 'TS (mg-S/L)', 'Nitrate (mg-N/L)', 'pH', 'Alkalinity (mmol/L)', 'ISS total (mg-ISS/L)', 'Metal soluble - Ca (mg/L)', 'Metal soluble - Mg (mg/L)', 'Gas - Dissolved O2 (mg/L)'].
     - If the influent type is variable (Dictionary):
-            Each Dictionary key corresponds to a different scenario.
+        Each Dictionary key corresponds to a different scenario.
             - Each Dictionary key column corresponds to the influent's parameters in the same order of appearance in BioWin: column_names = ['Time','Flow', 'COD (mg-COD/L)', 'TKN (mg-N/L)', 'TP (mg-P/L)', 'TS (mg-S/L)', 'Nitrate (mg-N/L)', 'pH', 'Alkalinity (mmol/L)', 'ISS total (mg-ISS/L)', 'Metal soluble - Ca (mg/L)', 'Metal soluble - Mg (mg/L)', 'Gas - Dissolved O2 (mg/L)'].
             - Each Dictionary key row corresponds to the influent's parameters at the time specified in the time grid (minutes, days, hours).
             - Dictionary entries should be ordered from the one with the least number of rows to the one with the most.
+
 - seed_mass: sets seed values for flow mass balance. Choose between the program options: 'seed' (seed), 'current' (current values), 'last' (last steady state), 'complex' (complex seed). 'None' for not running flow balance.
+
 - seed_SS: sets seed values for the steady state simulation. Choose between the program options: 'seed' (seed), 'current' (current values), 'last' (last steady state), 'complex' (complex seed).
+
 - max_simulation_time: sets the maximum time (in seconds) for finding the steady-state solution of each scenario. If the time for finding the solution exceeds the maximum time, the simulation will stop.
+
 - result_type: 'table' (csv file with results specified in Album. The API copies the results present in the Page 1 of the Album and saves them in a csv file), 'report' (excel report generated by BioWin) , 'complete' (csv file and excel report) ,'none' (does not save simulation results).
+
 - filepath: specifies where the generated files are saved. Use de form r"filepath".
     - For simulations with constant influent, and result type 'table': filepath for saving csv file.
     - For simulations with constant influent, and result type 'report': filepath does not has to be specified. The excel report generated by BioWin will be saved in the specified filepath in BioWin (File->Report to Excel->File path).
-    - For simulations with variable influent: a .txt file is generated by the function to ease influent data loading in BioWin. Filepath specifies where to save the .txt file with influent data, The chosen filepath must be the same as the filepath selected in BioWin influent window to load the data (***). Choosing the same filepath where BioWin file is located is recommended.  
+    - For simulations with variable influent: a .txt file is generated by the function to ease influent data loading in BioWin. Filepath specifies where to save the .txt file with influent data, The chosen filepath must be the same as the filepath selected in BioWin influent window to load the data (***). Choosing the same filepath where BioWin file is located is recommended.
+
 
 Returns: