Difference between revisions of "Target Platform"

From Developer Documents
Jump to navigation Jump to search
(Removed link to deprecated/invalid instructions.)
 
(41 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
* selected parts of the Eclipse SDK ([http://wiki.eclipse.org/index.php/Rich_Client_Platform RCP], [http://wiki.eclipse.org/Equinox/p2 P2], [http://www.eclipse.org/jdt/ JDT], [http://www.eclipse.org/pde/ PDE])
 
* selected parts of the Eclipse SDK ([http://wiki.eclipse.org/index.php/Rich_Client_Platform RCP], [http://wiki.eclipse.org/Equinox/p2 P2], [http://www.eclipse.org/jdt/ JDT], [http://www.eclipse.org/pde/ PDE])
 
* Simantics SDK
 
* Simantics SDK
* some third-party components
+
* some third-party components (see [[Licensing]])
  
Target main platform maintainer is [[User:Tuukka Lehtonen|Tuukka Lehtonen]]
+
== Maintenance ==
  
See [[Development_Practices#Deploying plug-ins for the target platform|Deploying plug-ins for the target platform]] for instructions on contributing to the target platform.
+
Simantics target platform maintainer is [[User:Tuukka Lehtonen|Tuukka Lehtonen]].
  
= P2 deployment =
+
=== From Simantics 1.31.0 onwards ===
  
== Simantics 1.4 ==
+
In Simantics 1.31.0 we migrated to Eclipse 4.7 Oxygen platform and took Obeo's ''Target Platform Definition DSL and Generator tool'' into use (see https://github.com/mbarbero/fr.obeo.releng.targetplatform) in target platform definition.
;Usage
 
* Install Eclipse IDE and Subversion connectivity plug-ins into it.
 
* Install the [[org.simantics.graph]] Graph Compiler version 1.1.5 into the IDE to develop ontologies.
 
* Checkout [[svn:target/branches/1.4]] project from the [[svn:|Simantics SVN]] into your workspace.
 
* Open the contained '''.target''' file and from the top-right corner of the ''target definition'' editor, click '''Set as Target Platform'''
 
** This will make Eclipse download the target platform components from '''simantics.org''' and install them as your target platform.
 
  
= Old deployment format =
+
= P2 deployments =
  
The following describe pre-simantics-1.4 target platform deployments. Starting from Simantics 1.4 we switch to [http://www.eclipse.org/equinox/p2/ P2]-based distribution.
+
[http://www.eclipse.org/equinox/p2/ P2] is a technology for provisioning software components for OSGi applications (e.g. anything Eclipse-based) originating from the [http://eclipse.org/equinox/ Eclipse/Equinox] project.
  
== ''master'' ==
+
== Register to access source code ==
;Description: Latest development version of the development version of the official Simantics target platform. This target platform is then branched and tagged for releases like 1.2, 1.3 and so on. Release branches are used for pre-release stabilisation which then turn into tags at the point of release.
 
  
;Download: [[svn:target/master]]
+
{{tip|Simantics is an open source software platform, licensed under Eclipse Public License EPL (more information in section [https://www.simantics.org/simantics/about-simantics/licensing Licensing]). The source code for both semantic database engine Simantics Core and the client Simantics Workbench is available to '''registered users'''. To gain access to the complete Simantics SDK source code, go to the [https://www.simantics.org/members/index.php Simantics Members Wiki] and [https://www.simantics.org/members/index.php/Special:RequestAccount request an account].}}
;Notes: [[svn:target/master/README.TXT]]
 
;Usage: Just download the target platform, set it in your Eclipse IDE and possibly download your own existing plug-ins.
 
;Change Log: [https://www.simantics.org/redmine/projects/simantics/repository/show/target/master Redmine], synced with trunks up to [https://www.simantics.org/redmine/projects/simantics/repository/revisions/18315 r18315]
 
  
== Simantics 1.2.1 ==
+
== Getting a Git-based version of the Simantics target platform ==
;Download: [[svn:target/branches/1.2.1]]
 
;Notes: [[svn:target/branches/1.2.1/README.TXT]]
 
;Usage: Just download the target platform, set it in your Eclipse IDE and possibly download your own existing plug-ins. Install the [[org.simantics.graph]] Graph Compiler version 1.0.3 into your IDE to develop ontologies.
 
;Change Log: [[redmine:projects/simantics/repository/show/target/branches/1.2.1|Redmine]], built from SVN revision [[redmine:projects/simantics/repository/revisions/18823|r18823]]
 
  
== Simantics 1.2 ==
+
For more information on our git-based environment, see [[Migration To Git]].
;Download: [[svn:target/branches/1.2]]
 
;Notes: [[svn:target/branches/1.2/README.TXT]]
 
;Usage: Just download the target platform, set it in your Eclipse IDE and possibly download your own existing plug-ins.
 
;Change Log: [[redmine:projects/simantics/repository/show/target/branches/1.2|Redmine]], synced with trunks up to [[redmine:projects/simantics/repository/revisions/18322|r18322]]
 
  
== Deprecated ==
+
In the following, the '''master''' version will be retrieved but the instructions apply to all published branches in the Git repository. To use any other version, just change '''/master/''' to another published branch name.
  
=== Simantics 1.1.0 ===
+
# '''Get the target platform definitions'''
;Download: [[svn:target/tags/1.1.0]]
+
#* Installing without Git
;Notes: [[svn:target/tags/1.1.0/README.TXT]]
+
#** Select menu item ''File/New/Project'' to create a new empty project.
;Usage: Just download the target platform, set it in your Eclipse IDE and possibly download your own existing plug-ins.
+
#** Download http://www.simantics.org/download/master/simantics.target into the new project
;Change Log: [https://www.simantics.org/redmine/projects/simantics/repository/show/target/branches/1.1 Redmine], synced with trunks up to [https://www.simantics.org/redmine/projects/simantics/repository/revisions/17778 r17778]
+
#* Installing through Git
 +
#** Follow the instructions at [[Migration To Git#Instructions for Simantics Developers]] for cloning the Simantics Platform repository
 +
# '''Activate the target platform'''
 +
#* Select menu item ''Window/Preferences'' from your Eclipse IDE.
 +
#* Open the preference page ''Plug-in Development/Target Platform''.
 +
#* Activate the ''Simantics x.y.z'' target platform definition by checking it and pressing Apply. Wait until Eclipse finishes downloading. Press ''OK'' or ''Apply and Close''.
 +
#** This will make Eclipse download the target platform components from '''simantics.org''' and install them as your target platform.
 +
# '''Keep your platform up-to-date'''
 +
#* Pull latest changes from Git remote repository
 +
#* From Target Platform preference page, select your target from the list and press the '''Reload''' button.
  
=== Simantics 1.0 (DEPRECATED) ===
+
== OLD: Getting a Subversion-based version of the Simantics target platform ==
:Download: [[svn:target/branches/1.0]]
 
  
:Notes:
+
Up to Simantics 1.24.0 we kept Simantics in SVN. These instructions apply for any SVN-based versions.
:* Steps to get the right code for the products to work:
 
:** Import [[svn:project-set/branches/1.0/simantics.psf|1.0 project set]]
 
  
; Contents
+
In the following, the version 1.22 will be retrieved but the instructions apply to all versions. In this case 1.22 means getting the latest built target platform for the 1.22 platform branch. To use any other version, just change the version number to any other version.
: Eclipse RCP
 
: Equinox P2
 
: Eclipse PDE
 
: Apache Commons 1.0.0 (org.apache.commons)
 
: Apache Lucene 3.0.0 (org.apache.lucene3)
 
: iText 2.1.5 (com.lowagie.text)
 
: Mylyn Wikitext (org.eclipse.mylyn.wikitext)
 
: HSQLDB (org.hsqldb)
 
: JFree Common/Chart (1.0.16/1.0.13)
 
: OPC-UA (org.opcfoundation.ua) (1.0.232.0)
 
: [[org.simantics.data]] (0.6.2)
 
: [[org.simantics.datatype]] (0.3.4)
 
: [[org.simantics.g2d.feature|org.simantics.g2d]] (0.9.2)
 
: [[org.simantics.fastlz]] (1.0.0)
 
: [[org.simantics.units]] (0.1.1)
 
  
=== Simantics 0.7 (DEPRECATED) ===
+
# '''Get the target platform definitions'''
:Download: [[svn:target/branches/0.7]]
+
#* Installing without SVN
 +
#** Select menu item ''File/New/Project'' to create a new empty project.
 +
#** Download the following files and copy them into the new project:
 +
#*** http://www.simantics.org/download/1.22/simantics.target
 +
#** For members, source code access is available through these alternative target definitions:
 +
#*** http://www.simantics.org/download/1.22/simantics-sdk.target
 +
#* Installing through SVN
 +
#** Checkout [[svn:target/branches/1.22]] project from the [[svn:|Simantics SVN]] into your workspace.
 +
# '''Activate the target platform'''
 +
#* Select menu item ''Window/Preferences'' from your Eclipse IDE.
 +
#* Open the preference page ''Plug-in Development/Target Platform''.
 +
#* Activate the ''Simantics 1.22'' target platform definition by checking it and pressing Apply. Wait until Eclipse finishes downloading. Press OK.
 +
#** '''Members:''' Select '''Simantics SDK 1.22''' for source code access instead. Use the SVN credentials available in the members wiki when Eclipse asks for the credentials to the target platform.
 +
#** This will make Eclipse download the target platform components from '''simantics.org''' and install them as your target platform.
 +
# '''Keep your platform up-to-date'''
 +
#* Updating should in theory be as easy as reloading the target platform from Target Platform preference page. Select your target from the list and then press the '''Reload''' button. However, in order to make Eclipse actually reload everything properly, it may be necessary to:
 +
#*# Copy the current target platform file to a new file with another name
 +
#*# Bump the ''sequenceNumber'' attribute value up +1 in the .target file
 +
#*#* look for <target name="..." sequenceNumber="1502690603"> at the beginning of the file
 +
#*# Activate the copied target platform
  
:Notes:
+
= Deprecated deployments =
:* Steps to get the right code for the products to work:
 
:** Import [[svn:project-set/branches/0.7/simantics.psf|0.7 project set]]
 
  
; Contents
+
See [[Deprecated Target Platforms]].
: Eclipse RCP
 
: Equinox P2
 
: Eclipse PDE
 
: Apache Commons 1.0.0 (org.apache.commons)
 
: Apache Lucene 2.4.1 (org.apache.lucene)
 
: iText 2.1.5 (com.lowagie.text)
 
: Mylyn Wikitext (org.eclipse.mylyn.wikitext)
 
: HSQLDB (org.hsqldb)
 
: JFree Common/Chart (1.0.16/1.0.13)
 
: OPC-UA (org.opcfoundation.ua) (1.0.232.0)
 
: [[org.simantics.data]] (0.6.2)
 
: [[org.simantics.datatype]] (0.3.4)
 
: [[org.simantics.db]] (0.7.1)
 
: [[org.simantics.g2d]] (0.9.0)
 
: [[org.simantics.fastlz]] (1.0.0)
 
: [[org.simantics.units]] (0.1.1)
 
  
 
[[Category: Miscellaneous Documents]]
 
[[Category: Miscellaneous Documents]]

Latest revision as of 10:21, 28 August 2017

The target platform is a composition of OSGi bundles, i.e. Eclipse plug-ins and features. This is the platform on top of which Simantics and its applications are developed. It consists roughly of:

  • selected parts of the Eclipse SDK (RCP, P2, JDT, PDE)
  • Simantics SDK
  • some third-party components (see Licensing)

Maintenance

Simantics target platform maintainer is Tuukka Lehtonen.

From Simantics 1.31.0 onwards

In Simantics 1.31.0 we migrated to Eclipse 4.7 Oxygen platform and took Obeo's Target Platform Definition DSL and Generator tool into use (see https://github.com/mbarbero/fr.obeo.releng.targetplatform) in target platform definition.

P2 deployments

P2 is a technology for provisioning software components for OSGi applications (e.g. anything Eclipse-based) originating from the Eclipse/Equinox project.

Register to access source code

Tip.png Simantics is an open source software platform, licensed under Eclipse Public License EPL (more information in section Licensing). The source code for both semantic database engine Simantics Core and the client Simantics Workbench is available to registered users. To gain access to the complete Simantics SDK source code, go to the Simantics Members Wiki and request an account.

Getting a Git-based version of the Simantics target platform

For more information on our git-based environment, see Migration To Git.

In the following, the master version will be retrieved but the instructions apply to all published branches in the Git repository. To use any other version, just change /master/ to another published branch name.

  1. Get the target platform definitions
  2. Activate the target platform
    • Select menu item Window/Preferences from your Eclipse IDE.
    • Open the preference page Plug-in Development/Target Platform.
    • Activate the Simantics x.y.z target platform definition by checking it and pressing Apply. Wait until Eclipse finishes downloading. Press OK or Apply and Close.
      • This will make Eclipse download the target platform components from simantics.org and install them as your target platform.
  3. Keep your platform up-to-date
    • Pull latest changes from Git remote repository
    • From Target Platform preference page, select your target from the list and press the Reload button.

OLD: Getting a Subversion-based version of the Simantics target platform

Up to Simantics 1.24.0 we kept Simantics in SVN. These instructions apply for any SVN-based versions.

In the following, the version 1.22 will be retrieved but the instructions apply to all versions. In this case 1.22 means getting the latest built target platform for the 1.22 platform branch. To use any other version, just change the version number to any other version.

  1. Get the target platform definitions
  2. Activate the target platform
    • Select menu item Window/Preferences from your Eclipse IDE.
    • Open the preference page Plug-in Development/Target Platform.
    • Activate the Simantics 1.22 target platform definition by checking it and pressing Apply. Wait until Eclipse finishes downloading. Press OK.
      • Members: Select Simantics SDK 1.22 for source code access instead. Use the SVN credentials available in the members wiki when Eclipse asks for the credentials to the target platform.
      • This will make Eclipse download the target platform components from simantics.org and install them as your target platform.
  3. Keep your platform up-to-date
    • Updating should in theory be as easy as reloading the target platform from Target Platform preference page. Select your target from the list and then press the Reload button. However, in order to make Eclipse actually reload everything properly, it may be necessary to:
      1. Copy the current target platform file to a new file with another name
      2. Bump the sequenceNumber attribute value up +1 in the .target file
        • look for <target name="..." sequenceNumber="1502690603"> at the beginning of the file
      3. Activate the copied target platform

Deprecated deployments

See Deprecated Target Platforms.