OpenJUMP Readme file
--------------------
Version 20250115 snapshot rev.5303[6c9a02d]

15. January 2025

Contents
--------
1. Licensing & sources
2. Installation instructions
3. Running OpenJUMP
4. Support
5. OpenJUMP history
6. Credits


1. Licensing & sources
----------------------
OpenJUMP is distributed under the GNU General Public License version 2 (GPLv2).
The license text can be found in the file "licenses/gpl-2.txt".

Sources for OpenJUMP itself and most of the extensions can be found on
 https://github.com/openjump-gis/
and are mirrored on
 https://gitlab.com/openjump-gis/
.
Sources in other locations can be found in the component's description below.

OpenJUMP uses and distributes the following (in alphabetical order) formatted
as (Component name - License name - License file in "licenses/" folder or link)
 BeanShell - LGPL2.1 - lgpl-2.1.txt
 Buoy Framework - Public Domain
 Code2000 Unicode font - GPL2 - gpl-2.txt
 Commons Codec, Compress, Imaging, IO, Lang3, Logging
   - Apache License Version 2.0 - apache_license-2.0.txt
 CTS - GNU Lesser General Public License (GNU LGPL)
 Esri projection list (resources/coord_ref_sys/pe_list_projcs_geogcs)
   - Apache License Version 2.0 - apache_license-2.0.txt
 Extensible-TIFF-JAI (xtiff jai) - MIT License - MIT-license.txt
 Icons (some original or based fully or in part on the following)
   FAMFAMFAM Silk by http://www.famfamfam.com - CC BY 2.5
    - http://creativecommons.org/licenses/by/2.5/
   Fugue by Yusuke Kamiyamane http://p.yusukekamiyamane.com - CC BY 3.0
    - http://creativecommons.org/licenses/by/3.0/
   OJ icon v3 and others by Edgar Soldin http://soldin.de - GPL2 - gpl-2.txt
   [ok|ko]_pg.png PostgreSQL icon - Trademark Policy
    - https://wiki.postgresql.org/wiki/Trademark_Policy
   [ok|ko]_mariadb.png MariaDB icon - MariaDB Branding Guidelines
    - https://mariadb.com/kb/en/mariadb/branding-guidelines/
   ok_spatialite.png Spatialite icon, dolphin_icon.png (Edgar Soldin)
    - GPL3 - gpl-3.txt
 ImageIO Ext - LGPL3 - lgpl-3.0.txt
   just minimal inclusion 'lib/ext/imageio-ext/' to enable TIFF support 
   for Raster files
   except the following dependencies/components:
    imageio-ext-streams - partly LGPL2 or 3 - imageio-ext-streams-LICENSE.txt
    imageio-ext-tiff - BSD style license - imageio-ext-tiff-BSD-LICENSE.txt
 JAI core, codec - Java Advanced Imaging Distribution License - jdl-jai.pdf
 JAI imageio core - BSD style license - jai-core.BSD-LICENSE.txt
 JAI-imageio-core (standalone) - BSD 3-style with nuclear exception
   - jai-imageio-core-LICENSE.txt
 JAMA - Public Domain
 Jdom - Apache-style open source jdom license, with the acknowledgment 
   clause removed - jdom_license.txt
 JMath and its successor projects JMathTools (IO,Plot,Array)
   - BSD license - jmath_license.txt
 JSON-simple - Apache License Version 2.0 - apache_license-2.0.txt
 JTS Topology Suite - LGPL2 - lgpl-2.1.txt
 JUnit - Eclipse Public License v1.0 - epl-v10.txt
 Jython - Jython license - jython_license.txt
 Log4J - Apache License Version 2.0 - apache_license-2.0.txt
 Logo
   Splash Logo designed by Paola Zanetti (paoladorileo<AT>gmail.com)
   Vertical Design used in the installer by Stefan Steiniger 2012
 Netbeans swing outline - Apache License Version 2.0 - apache_license-2.0.txt
 Outline Swing Component by Netbeans.org, GPL2 - gpl-2.txt
 Postgresql JDBC driver - Postgresql BSD license - postgresql-BSD_license.txt
 Simple Logging Facade for Java (SLF4J) - MIT License - MIT-license.txt
   lib/slf4j-api-*.jar,slf4j-api-*.jar
 Xerces2 Java Parser - Apache License Version 2.0 - apache_license-2.0.txt
 XZ for Java - Public Domain

and the following plugins
( Component name - License name - License file in "licenses/" folder
   list of files and dependencies with license if any )
 Oracle Datastore (Nicolas Ribot) - GPL2 - gpl-2.txt
 SkyPrinter - GPL2 - gpl-2.txt
   SkyPrinterPlugIn-*.jar
   itext-*.jar - LGPL2.1 - lgpl-2.1.txt


Additionally PLUS distribution contains
( Component name (Author) - License name - License file in "licenses/" folder
   list of files and dependencies with license if any )
 Batik SVG Toolkit - Apache License Version 2.0 - apache_license-2.0.txt
 ECW and JPEG2000 Read Support based on ECW SDK 3.3 for 
   Windows x86/x64, Linux, Mac OSX with 32bit java runtime -
   ERDAS ECW JPEG2000 SDK license - ecw license.txt
   lib/native/[os/]{jecw-*.jar,NCS*.dll,ermapper.jar}
 ImageIO Ext - LGPL3 - lgpl-3.0.txt
   except the following dependencies/components:
   commons-codec, commons-io, commons-lang, commons-logging (see above)
   imageio-ext-imagereadmt - BSD style license
    - imageio-ext-imagereadmt-BSD-LICENSE.txt
   turbojpeg-wrapper - BSD style license - LICENSE.libjpegturbo.txt
 JEdit (1999) - GPL2 - gpl-2.txt
 JGraphT - LGPL2 - lgpl-2.1.txt
   lib/jgrapht-*.jar
 Postgis driver (postgis-*.jar) - LGPL2 - lgpl-2.1.txt
 MariaDB Connector/J (mariadb-java-client-*.jar) - LGPL2 - lgpl-2.1.txt
 MySQL Connector/J (mysql-connector-java-*-bin.jar) - GPL2 - gpl-2.txt
 Xerial SQLite JDBC driver (sqlite-jdbc-*.jar) - apache_license-2.0.txt

and the following plugins
 Aggregation PlugIn (Michaël Michaud) - GPL2 - gpl-2.txt
   aggregation-*.jar
 BeanShell Editor (Michaël Michaud) - GPL2 - gpl-2.txt
   bsheditor4jump-*.jar, buoy.jar(see above)
 CAD Tools (Giuseppe Aruta) - GPL3 - gpl-3.0.txt
   CadTools-*.jar
 CSV driver (Michaël Michaud) - GPL2 - gpl-2.txt
   csv-driver-*.jar
 Concave Hull (Eric Grosso) - LGPL2.1, GPL2 - lgpl-2.1.txt, gpl-2.txt
   ConcaveHull*.{jar,txt}
 DXF driver (Michaël Michaud) - GPL2 - gpl-2.txt
   driver-dxf-*.jar
 Five Color Map Coloring (Larry Reeder) - GPL3 - gpl-3.0.txt
   SLF4J (see above), JGraphT (see above)
 Graph Extension (Michaël Michaud) - GPL2 - gpl-2.txt
   graph-toolbox-*.jar, lib/jump-jgrapht-*.jar
   JGraphT (see above)
 Jump Chart (com.cadplan.jump) - GPL2 - gpl-2.txt
   JumpChart.jar
 Jump Fill Pattern (com.cadplan.jump) - GPL2 - gpl-2.txt
   JumpFillPattern.jar
 KML Driver (skyjump) - GPL2 - gpl-2.txt
   kml-driver-*.jar
 Matching (Michaël Michaud) - GPL2 - gpl-2.txt
   matching-*.jar
   utils-*.jar
 Measure Toolbox (Giuseppe Aruta) - GPL3 - gpl-3.0.txt
   MeasureToolbox_*.jar
 OpenKLEM (Geomatica) - GPL2 - gpl-2.0.txt
   topographic and hydrological analysis
   OpenKLEM-*.jar
   OpenKLEMOJ-*.jar
 Printer (com.cadplan.jump) - GPL2 - gpl-2.txt
   jumpPrinter.jar (needs Vertex Symbols extension)
   itext-*.jar - LGPL2.1 - lgpl-2.1.txt
 Raster Tools (Geo Arbores - Giuseppe Aruta) - GPL3 - gpl-3.txt
  - https://sourceforge.net/p/opensit/code/
  RasterTools-*.jar
   containing parts of these projects
    ImageJ - Public domain
    WhiteBox GAT GIS - GPL3 - gpl-3.txt
    JEP 1.2 - GPL3 - gpl-3.txt
 SetAttributes (Michaël Michaud) - GPL2 - gpl-2.txt
   SetAttributes-.jar
   jaxb/jaxb-*.jar
 Sextante Tools (es.unex.sextante.openjump.extensions) - GPL3 - gpl-3.0.txt
   sextante-binding-*.jar, sextante/*.*
 Sextante algorithms  (www.scolab.es) - GPL3 - gpl-3.0.txt
   sextante_new_algorithms.jar
 Topology Extension (Michaël Michaud) - GPL2 - gpl-2.txt
   topology-*.jar
 Vertex Note (com.cadplan.jump) - GPL2 - gpl-2.txt
 Vertex Symbols (com.cadplan.jump) - GPL2 - gpl-2.txt
   VertexSymbols.jar
   itext-*.jar - LGPL2.1 - lgpl-2.1.txt
   lib/ext/VertexImages/*.wkt (Geo Arbores - Giuseppe Aruta)
 View Manager Extension (Michaël Michaud) - GPL2 - gpl-2.txt
   ViewManager-*.jar
   jaxb/jaxb-*.jar


2. Installation instructions
----------------------------
Try the shiny installers (for linux & mac)
 OpenJUMP-Installer-*.jar
Or
 Extract the portable zip file distribution.
 OpenJUMP-Portable-*.zip


3. Running OpenJUMP
-------------------
To start OpenJUMP run the launcher for your platform from the 
<appfolder>/bin/ directory.
- On Windows, double-click on oj_windows.bat or OpenJUMP.exe
- On Linux/Unix, launch oj_linux.sh
- On MacOSX, launch oj_mac.command or OpenJUMP.app

Additionally, if you used the installer you should have
- On Windows, a start menu entry.
- On Linux, a link on the desktop.
- On MacOSX, a self contained app on the desktop. 
  Move it to 'Applications' folder if you like.

Further information can be found in the OJ wiki: http://ojwiki.soldin.de


Startup/Command line options
----------------------------
Several startup options are available, either for the Java Virtual Machine, 
or for the OpenJUMP application. To change them, edit the startup script 
accordingly. The scripts contain documentation comments, don't be afraid.

Useful Java VM options
-Xms defines the allocated memory for the virtual machine at startup.
  Example: -Xms256M will allocate 256M of memory for OpenJUMP
-Xmx defines the maximum allocated memory for the virtual machine.
  Example: -Xmx256M
-Dproperty=value set a jvm system property.

OpenJUMP command line syntax:

  oj_starter -option <argument> ... <[data|project]_file>...

OpenJUMP options:

  -default-plugins <file.xml>
    Specifies the configuration file of a standard set of functions realized
    as plugins. For example almost all functions of the "Tools" menu.
    This is configured as
      -default-plugins bin\default-plugins.xml

  -h, -help
    show the help information

  -i18n <locale>
    Overrides the operating systems default locale setting (language, 
    number format etc.) For example:
    - For starting OpenJUMP in French: use -i18n fr
    - languages available (09/2011): 
      cz (czech)
      de (german)
      en (english)
      es (spanish)
      fi (finnish)
      fr (french)
      hu (hungarian)
      it (italian)
      ja_JP (japanese)
      ml (malayalam)
      pt (portuguese)
      pt_BR (brazilian portuguese)
      ta_IN (indian tamil)
      te (telugu)
      zh_CN (chinese simplified)
      zh_HK (chinese Hong Kong)
    ATTENTION: If the specified language is not available then
               the language used is english (en).

  -extensions-directory <path> 
    Sets the location of the extensions folder. Can be defined multiple times.
    Look for extensions in <path>/*.jar files, adds all jar-files recursively
    to runtime classpath. (see also -limit-ext-lookup)
    Default: JUMP_HOME/lib/ext

  -jars-directory <path>
    Adds all contained jar-files recursively to runtime classpath.
    Can be defined multiple times.

  -limit-ext-lookup true|false
    Limits the search for extensions in jar files to jar-files contained in
    extension-directory folder root. Setting to 'false' enables extension
    lookup in all jars + class files recursively (for devel purposes).
    Default: true (to speed up OJ start)

  DEPRECATED: use '-extensions-directory','-jars-directory','-limit-ext-lookup'
  -properties <file.xml>
    specifies the file where OpenJUMP persistent properties are stored.
    See Wiki article "How to use a plugin with a properties file in ECLIPSE".
    Default: JUMP_HOME\bin\workbench-properties.xml

  -state <some/folder>
    specifies the folder where OpenJUMP stores data between executions
    (workbench-state.xml).
    Default: JUMP_HOME or SETTINGS_HOME

  -v, -version
    show version information


4. Support
----------
for a general overview visit
  www.openjump.org - the OpenJUMP web site
  jump-pilot.sourceforge.net - alternative domain to the above
for support
  consult the OJ wiki
    http://ojwiki.soldin.de
  use mailing list or trackers
    http://ojwiki.soldin.de/index.php?title=OpenJUMP_Support

For commercial support, e.g. paid plugin development, contact the developer 
mailing list http://lists.sourceforge.net/lists/listinfo/jump-pilot-devel .


5. OpenJUMP history
-------------------
OpenJUMP is a "fork" of the JUMP "Java Unified Mapping Platform" software,
developed by Vividsolutions and released in 2003.
During 2004, some enthusiastic developers joined together to enhance further 
the features of JUMP. They launched an independent development branch called 
OpenJUMP. This name gives credit to the original JUMP development, and at the 
same time describes the objectives of this project to be fully open to anyone
wanting to contribute.
Since May 2005 a complete development source is available at:
www.sourceforge.net/projects/jump-pilot
In 2021, OpenJUMP moves to Github : https://github.com/openjump-gis/openjump


6. Credits
----------
Many thanks to all the contributors of OpenJUMP for their time and efforts:

Original development team of JUMP was:
  at Vividsolutions (www.vividsolutions.com)
    Martin Davis
    Jon Aquino
    Alan Chang 
  at Refractions Research Inc (www.refractions.net) 
    David Blasby 
    Paul Ramsey 

OpenJUMP project team (in alphabetical order):
  Edgar Soldin (edso, http://soldin.de)
  Giuseppe Aruta
  Jukka Rahkonen
  Michaël Michaud

Continuous or recent contributors (in alphabetical order):
  Nicolas Ribot

Past contributors (in alphabetical order):
  Alberto de Luca (geomaticaeambiente.it)
  Andreas Schmitz (lat-lon.de)
  Axel Orth
  Basile Chandesris
  Bing Ran
  Eric Lemesre
  Erwan Bocher
  Ezequias Rodrigues da Rocha
  Fco Lavin
  Geoffrey G Roy
  Hisaji Ono
  Jaakko Ruutiainen
  Jan Ruzicka
  Joe Desbonet
  John Clark
  Jonathan Aquino
  Kevin Neufeld
  Landon Blake (Sunburned Surveyor)
  Larry Becker (ISA.com)
  Larry Reeder
  Martin Davis (refractions.net)
  Matthias Scholz
  Mohammed Rashad
  Neutius
  Ole Rahn
  Paolo Rizzi
  Paul Austin
  Pedro Doria Meunier
  Sascha Teichmann (intevation.de)
  Stefan Steiniger (on hiatus)
  Stephan Holl
  Steve Tanner
  Ugo Taddei
  Uwe Dallüge

Translation contributors are
  Chinese: Elton Chan
  Czech: Jan Ruzicka
  English: Landon Blake
  Finnish: Jukka Rahkonnen
  French: Basile Chandesris, Erwan Bocher, Steve Tanner, Michaël Michaud
  German: Florian Rengers, Stefan Steiniger, Edgar Soldin
  Hungarian: Zoltan Siki
  Italian: Giuseppe Aruta
  Japanese: Hisaji Ono
  Malayalam : Mohammed Rashad
  Portuguese (brazilian):
    Ezequias Rodrigues da Rocha, 
    Cristiano das Neves Almeida
  Spanish:
    Giuseppe Aruta, Steve Tanner, Fco Lavin, 
    Nacho Uve, Agustin Diez-Castillo
  Tamil: Vikram Santhanam
  Telugu: Ravi Vundavalli

Contributing projects and companies:
- Intevation GmbH
  Nightly Build process, collaborative PlugIn development (Print Layout PlugIn)
  contact: Jan Oliver Wagner/Stephan Holl
- Larry Becker and Robert Littlefield (SkyJUMP team)
  partly at Integrated Systems Analysts, Inc.
  for providing their Jump ISA tools code and numerous other improvements
- Lat/Lon GmbH (deeJUMP team)
  for providing some plugins and functionality (i.e. WFS and WMS Plugins)
  contact: Markus Müller/Andreas Schmitz
- Pirol Project from University of Applied Sciences Osnabrück
  for providing the attribute editor. Note that the project is finished now.
  (contact: Arnd Kielhorn)
- VividSolutions Inc. & Refractions Inc.
  for support and answering the never ending stream of questions, especially:
  Martin Davis (now at Refractions Inc.)
  David Zwiers

others:
- L. Paul Chew for providing the Delaunay triangulation algorithm to 
  create Voronoi diagrams

