create compas sct documentation

Signed-off-by: Mohamed Sylla <[email protected]>

Author: syllamoh

doc/compas-sct.md

@@ -0,0 +1,30 @@
+<!-- SPDX-FileCopyrightText: 2020 RTE FRANCE -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+# COMPAS SCT (Substation Configuration Tool)
+## Introduction
+
+
+System Configuration Tool (SCT) is part of CoMPAS open source project. It goal is to bring a flexible and adaptative tool for configuring PACS (Power Automation and power Control System). It's an n-tiers architecture which combine reliabilitily, flexibility, modularity and adaptability to allows users to choose their own database to implement the SCT.
+
+The following architecture is divided in three major parts:
+* sct-commons : ....
+* sct-service : this part could be considered as the engine of the SCT. It computes all needed operations and uses sct-data for database access.
+* sct-data : implements a generic abstract data service which should be extended by specific real data service for exchange with chosen database.
+* sct-app : *TODO*
+
+*Insert diagram here*
+
+
+## SCT COMMONS
+*TODO*
+## SCT DATA
+*TODO*
+### SQL-Like Database
+*TODO*
+### NoSQL-Like Database
+*TODO*
+## SCT SERVICE  
+*TODO*
+## SCT APPLICATION
+*TODO*

pom.xml

@@ -21,9 +21,10 @@
     </repositories>
 
     <properties>
-        <compas.core.version>0.2.1</compas.core.version>
+        <compas.core.version>local-SNAPSHOT</compas.core.version>
         <maven.compiler.target>11</maven.compiler.target>
         <maven.compiler.source>11</maven.compiler.source>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <sonar.coverage.exclusions>sct-coverage/**</sonar.coverage.exclusions>
         <aggregate.report.dir>../sct-coverage/target/site/jacoco-aggregate/jacoco.xml</aggregate.report.dir>
         <sonar.coverage.jacoco.xmlReportPaths>${basedir}/${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
@@ -38,7 +39,8 @@
     </dependencies>
     <modules>
         <module>sct-data</module>
-        <module>sct-data-postgres</module>
+        <module>sct-data-pg</module>
+        <module>sct-commons</module>
         <module>sct-service</module>
         <module>sct-coverage</module>
     </modules>

sct-commons/pom.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- SPDX-FileCopyrightText: 2021 RTE FRANCE -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.lfenergy.compas</groupId>
+        <artifactId>compas-sct</artifactId>
+        <version>local-SNAPSHOT</version>
+    </parent>
+
+    <groupId>org.lfenergy.compas</groupId>
+    <artifactId>sct-commons</artifactId>
+    <version>local-SNAPSHOT</version>
+
+    <properties>
+        <sonar.coverage.jacoco.xmlReportPaths>${basedir}/${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
+    </properties>
+</project>