home.md

@@ -8,6 +8,7 @@ HRU delin used to work with grass6 only. This version brings compatibility with
 
 * Grass7 compatibility
 * Parallelized process in step2, step3 and step4
+* ZirkelKill ported to Python3, no more Java dependency
 * Launch scripts now accept an optional parameter to specify where to find the config file (with any name)
 * Advanced progression display
 * Automatic grass environment building, no more need to build a "case"
@@ -88,7 +89,7 @@ You don't need to be in the same directory than the config file, so you can run
 ``` bash
 hru-delin_all-steps.sh ./projects/hydro/my_hrudelin_project.cfg
 ```
-and HRU delin will run just fine, producing outputs near the config file.
+and HRU delin will run just fine, producing outputs next to the config file.
 
 ### Number of parallel process
 
@@ -104,7 +105,7 @@ hru-delin_step4.sh my_hrudelin_project.cfg -p 8
 
 ### Multiple executions
 
-As HRU delin builds a specific grass environment each time it is launched, you can run it multiple times simultaneously. Each HRU delin instance won't mess with the others.
+As HRU delin builds a specific grass environment each time it is launched, you can run it multiple times simultaneously. Each HRU delin running instance won't mess with the others.
 
 For example, let's consider you have 8 cores and you want HRU delin to only use half of your processor's resources:
 ``` bash
@@ -113,4 +114,16 @@ hru-delin_all-steps.sh projects/rhone/rhone.cfg -p 2
 # and in another one
 hru-delin_all-steps.sh projects/danube/danube.cfg -p 2
 ```
-This way you'll have one HRU delin using 2 cores and another one using 2 cores as well.
+This way you'll have one HRU delin using 2 cores and another one using 2 cores as well.
\ No newline at end of file
+
+# CircleKill
+
+ZirkelKill has been translated to Python3. It is imported as a module and used by HRU delin? You can also use it as a standalone program if you want. It can be called like a binary and takes 2 arguments:
+* the input path (.par file)
+* the output path prefix
+
+Example:
+``` bash
+/path/to/hru-delin/modules/circleKill.py myFile.par fixedFile
+```
+This will write `fixedFile.par` and `fixedFile.dbf`.
\ No newline at end of file