CIM-anonymiser

docs/user/itools/cim_anonymizer.md

@@ -0,0 +1,40 @@
+---
+layout: default
+---
+
+# iTools cim-anonymizer
+
+The `cim-anonymizer` command is used to anonymize one or several CIM files. All the identifiers are replaced by new generated identifiers. The mapping between old and new identifiers is exported in a CSV file.
+
+## Usage
+```
+$> itools cim-anonymizer --help
+usage: itools [OPTIONS] cim-anonymizer --cim-path <PATH> [--help] --mapping-file
+       <FILE> --output-dir <DIR> [--skip-external-refs]
+
+Available options are:
+    --config-name <CONFIG_NAME>   Override configuration file name
+
+Available arguments are:
+    --cim-path <PATH>       CIM zip file or directory
+    --help                  display the help and quit
+    --mapping-file <FILE>   File to store the ID mapping
+    --output-dir <DIR>      Directory to write anonymized zip files
+    --skip-external-refs    Do not anonymize external references
+```
+
+### Required arguments
+
+**\-\-cim-path**  
+This option defines the CIM file (zip) or a directory where to look for CIM files.
+
+**\-\-mapping-file**  
+This option defines the CSV file where the mapping between original and new identifiers is exported.
+
+**\-\-output-dir**  
+This option defines the path of the directory where to write the anonymized CIM files. If the output directory doesn't exist, an exception is thrown.
+
+### Optional arguments
+
+**\-\-skip-external-refs**  
+This option defines if the XML external references should also be anonymized or not. The default value is `false`, meaning that the external references are also anonymized.

docs/user/itools/index.md

@@ -15,6 +15,7 @@ loadflow-validation.md
 run-script.md
 security-analysis.md
 sensitivity-computation.md
+cim_anonymizer.md
 ```
 
 The `iTools` script provides a command-line interface to interact with PowSyBl, available under Linux and Windows (MacOS is not supported yet).
@@ -90,7 +91,7 @@ The `iTools` script relies on a [plugin mechanism](): the commands are discovere
 | Command                                                                     | Theme           | Description |
 |-----------------------------------------------------------------------------| --------------- | ----------- |
 | [action-simulator](./action-simulator.md)                                   | Computation     | Run a security analysis with remedial actions |
-| [cim-anonymizer](cim-anonymizer.md)                                         | Data conversion | Anonymize CIM files |
+| [cim-anonymizer](cim_anonymizer.md)                                         | Data conversion | Anonymize CIM files |
 | [compare-security-analysis-results](./compare-security-analysis-results.md) | Computation     | Compare security analysis results |
 | [convert-network](convert_network.md)                                       | Data conversion | Convert a grid file from a format to another |
 | [dynamic-simulation](dynamic-simulation.md)                                 | Computation     | Run a dynamic simulation |