Continuing markdown conversion
authorTuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Thu, 13 Feb 2020 12:48:43 +0000 (14:48 +0200)
committerTuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Thu, 13 Feb 2020 12:55:24 +0000 (14:55 +0200)
gitlab #99

Change-Id: I81129bbba840369a43bdce0bcfee09a3836c51b8

docs/Topics/Basics.dita [new file with mode: 0644]
docs/User/Introduction.md
docs/dev.ditamap [new file with mode: 0644]

diff --git a/docs/Topics/Basics.dita b/docs/Topics/Basics.dita
new file mode 100644 (file)
index 0000000..55bc045
--- /dev/null
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
+<topic id="basics">
+    <title>Basics</title>
+</topic>
index 06ecc32b77889a8dbf5f7a629353a4bc995357ba..125e1b2cdd1eb00fd82e6484b9dfd5727d80a48a 100644 (file)
@@ -7,3 +7,30 @@ Simantics platform is used in open source and commercial modelling and simulatio
 The philosophy of the Simantics platform is to offer an open, high level application platform on which different computational tools can be easily integrated to form a common environment for modelling and simulation. One of the biggest innovations in the Simantics platform is the semantic modelling approach. The data triple engine on the server side enables high performance data management and arbitrary mapping of data. This enables e.g. efficient mapping of simulation and measurement data to the model configuration and its visualisation.\r
 \r
 This *Simantics End User Documentation* provides information on the open source products that have been developed using Simantics platform. The basic principles of Simantics platform and some components common to all Simantics-based products are also explained. If you wish to dig deeper to the foundations of the Simantics platform or create your own modelling and simulation tool based on Simantics, see [Simantics Developer Documentation](../Developer/Introduction.md) or contact us through the [Simantics website](http://www.simantics.org).\r
+\r
+This page contains some information about the Simantics platform and its principles and concepts. For more information about the platform and how to join us, visit the simantics platform website [http://www.simantics.org www.simantics.org].\r
+\r
+## About Simantics Platform\r
+\r
+Simantics is a software platform especially for modelling and numerical simulation. It is a ground to build a modelling and simulation software on top of or to integrate different software tools. Simantics package does not include any "Simantics solver", but all the solvers are third party components. [[System Dynamics Modelling](http://sysdyn.simantics.org/) is currently the only Simantics-based open source modelling tool available.\r
+\r
+The platform contains graphical client software built on Eclipse Rich Client Platform (RCP) and a semantic graph database for holding most of the data. The innovation under the hood in Simantics is its semantic data model used for practically everything from 2D graphics to modelling data and model domain mappings - the database. The nicest feature of the semantic data model is the highly versatile creation of relations between related data in the data base.\r
+\r
+In addition to the database, Simantics platform contains many user interface elements and features that are common to most modelling and simulation tools like diagram, symbol library and experiment management. By utilizing the common components, new modelling, simulation and integration solutions don't have to developed from scratch. Common components also make it easier for users to start using new products.\r
+\r
+Some examples of what Simantics can be used for:\r
+* Graphical modelling environment for system simulation: For example plant modelling or electric circuit design using 2D diagram style graphical tools. \r
+* Solver communication and integration solution: A solution for connecting existing numerical solvers for co-simulation. \r
+* Solution for complex modelling data management: Data model for complex, large model base management, large model database that is developed by several modellers around the internet. \r
+* Platform and a set of tools for distributed model development and simulation: Large, worldwide organisations need tools that support their distributed organisation.\r
+\r
+## Simantics Development and Open Source\r
+\r
+Simantics platform is licensed under [Eclipse Public license (EPL)](http://www.eclipse.org/org/documents/epl-v10.html). The EPL license is a relatively flexible open source license that allows the products built on Simantics to have different licensing schema. Our intention is to do, obviously in smaller scale, the same that Linux has done to computer user's community. We try to introduce the same openness and sharing attitude to the modelling and simulation community. There are huge number of excellent simulation software available as open source, but often they lack easy-to-use interface and interoperability. Simantics tries to solve this problem by offering an open, vendor independent platform for pre- and post-processing tools and solver integration. In fact, the powerful data model and rich graphical user interface features enable much more to be built on the platform. With Simantics, we promote open source software, but that does not mean we would not support also proprietary software. All kind of software are welcome to utilise Simantics as long as their licensing does not conflict with the EPL license.\r
+\r
+## Simantics Concepts and Conventions\r
+\r
+Simantics user interface is built on top of Eclipse and thus the user interface logic follows what was introduced by the [Eclipse IDE](https://www.eclipse.org/eclipseide/). Simantics Workbench is a desktop development environment, the window of the application. Workbench window contains one or more perspectives. Perspectives contain views and editors and control what appears in certain menus and tool bars. More than one Workbench window can exist on the desktop at any given time.\r
+\r
+In Simantics views are used to represent data in different ways and editors are for the actual modelling. The structure of the perspectives with views, editors, menus and toolbars is adopted from Eclipse and is familiar to users that have used Eclipse before for example programming. For users that are not familiar with the Eclipse concepts, more information can be found from the Eclipse [Workbench User Guide](https://help.eclipse.org/2019-12/index.jsp).\r
+\r
diff --git a/docs/dev.ditamap b/docs/dev.ditamap
new file mode 100644 (file)
index 0000000..85832da
--- /dev/null
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
+<map id="org.simantics.doc.dev">
+    <title>Simantics Platform Developer Documentation</title>
+
+    <topicref href="README.md" format="markdown"/>
+
+    <topicref href="Topics/Basics.dita">
+      <topicref href="Basics/PrerequisitesAndInstallation.md" format="markdown"/>
+    </topicref>
+
+</map>