Difference between revisions of "Documentation"

From KalypsoDev
Jump to: navigation, search
(→‎How-Tos)
(→‎Online Manuals)
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
==Manuals==
+
== Online Manuals ==
−
'''Kalypso:'''
+
 
 +
Current Kalypso manuals are available online in the Kalypso Manual WIKI. Please find the following manuals:
 +
* [http://kalypso.bjoernsen.de/manual_15_1/index.php/Main_Page/de Current Version, Kalypso 15.1 (german)]
 +
* [http://kalypso.bjoernsen.de/manual_13_12/index.php/Main_Page/de Kalypso 13.12 (german)]
 +
* [http://kalypso.bjoernsen.de/manual_12_11/index.php/Main_Page/de Kalypso 12.11 (german)]
 +
 
 +
== PDF manuals (partly outdated) ==
 
:[http://downloads.sourceforge.net/kalypso/Manual_Kalypso1D2D_de_v2.0.1.pdf Kalypso1D2D]
 
:[http://downloads.sourceforge.net/kalypso/Manual_Kalypso1D2D_de_v2.0.1.pdf Kalypso1D2D]
 
:[http://downloads.sourceforge.net/kalypso/Manual_KalypsoFlood_de_v2.0.1.pdf KalypsoFlood]
 
:[http://downloads.sourceforge.net/kalypso/Manual_KalypsoFlood_de_v2.0.1.pdf KalypsoFlood]
 
:[http://downloads.sourceforge.net/kalypso/Manual_KalypsoRisk_de_v2.0.1.pdf KalypsoRisk]
 
:[http://downloads.sourceforge.net/kalypso/Manual_KalypsoRisk_de_v2.0.1.pdf KalypsoRisk]
 
:[http://downloads.sourceforge.net/kalypso/Manual_WSPM_de_v2.0.1.pdf KalypsoWSPM]
 
:[http://downloads.sourceforge.net/kalypso/Manual_WSPM_de_v2.0.1.pdf KalypsoWSPM]
 +
:[http://downloads.sourceforge.net/kalypso/KalypsoHydrology_Handbuch_2012_01_17.pdf KalypsoHydrology]
  
−
:[http://sourceforge.net/projects/kalypso/files/Kalypso%20Documents/2.2/Handbuch_KalypsoHydrology.pdf/download KalypsoHydrology]
+
==Releases and Change Logs==
−
 
+
:[[Development#Releases|See Change Logs]]
−
==References==
+
−
 
+
−
 
+
−
==How-Tos==
+
−
 
+
−
[[Using Sourceforge as SVN Mirror]]
+
−
 
+
−
[[Writing OpenOffice.org based DOCBOOK manuals]]
+
−
 
+
−
==FAQs==
+
−
 
+
−
===General===
+
−
 
+
−
 
+
−
====Installation====
+
−
 
+
−
{| border="1" cellpadding="10" cellspacing="5"
+
−
|-valign="top"
+
−
|width="40%"|'''How do I install Kalypso?'''
+
−
|width="60%"|
+
−
:Run the 'setup.exe'
+
−
:For a detailed installation guide: [https://sourceforge.net/project/downloading.php?group_id=227951&filename=InstallationGuide_en.pdf english] / [https://sourceforge.net/project/downloading.php?group_id=227951&filename=InstallationsAnleitung_de.pdf german]
+
−
|-valign="top"
+
−
|'''What is the kalypso.ini good for?'''
+
−
|
+
−
In the kalypso.ini file you can specify additional options:
+
−
:-nl <<language>>: Set program language (de_DE or en_EN). Defaults to de_DE
+
−
:-vmargs (arguments for the java virtual machine):
+
−
:-Xmx1024m : sets the maximum of allocated memory to 1024mb
+
−
:-XX:PermSize=64M
+
−
:-XX:MaxPermSize=128M
+
−
:-debug
+
−
:-consoleLog : activates a log window while Kalypso is running.
+
−
|-valign="top"
+
−
|'''Can I use an already installed version of Java?'''
+
−
|
+
−
|-valign="top"
+
−
|'''What Java version should I use?'''
+
−
|
+
−
Right now Kaylpso works only with Java 5.
+
−
|-valign="top"
+
−
|'''Do I need administrator rights for the installation process?'''
+
−
|
+
−
Yes.
+
−
|-valign="top"
+
−
|'''What is a working directory and how can I specify it?'''
+
−
|Your working directory is the place, where all your model data will be stored. By default is is set to the root folder of Kalypso. If you must handle huge models with lots of data you might want to change the location of your working directory.
+
−
You can specify a different location by creating a link to the kalypso.exe and adding the following parameter:
+
−
-data <<path>>: Set the path to your workspace folder (i.e. folder containing your data).
+
−
E.g.
+
−
-data c:\temp\eclipse_workspaces\deploy_workspaces
+
−
|-valign="top"
+
−
|'''Are there more parameters I need to know of?'''
+
−
|If you want to keep the temp data from the calculation cores (by default this data will be deleted) you can create a file '.options' in the root directory of Kalypso.
+
−
In this file you can specifiy a set of additional parameters:
+
−
:org.kalypso.simulation.ui/debug = true
+
−
:org.kalypso.simulation.ui/debug/keepSimulationFiles = true
+
−
|}
+
−
 
+
−
===Kalypso Hydrology===
+
  
 +
==Flash Animations==
  
 
===Kalypso WSPM===
 
===Kalypso WSPM===
−
{| border="1" cellpadding="10" cellspacing="5"
+
:[http://sourceforge.net/projects/kalypso/files/Kalypso/resources/animation/wspm/wspm1.swf/download WSPM (Overview)]
−
|-valign="top"
+
−
|width="40%"|'''What are the differences between WspWin and WSPM?'''
+
−
|width="60%"|[http://kalypso.bjoernsen.de/fileadmin/kalypso/documentation/Vergleich_WspWin_WSPM.pdf see here (german)]
+
−
|}
+
−
 
+
  
 
===Kalypso 1D/2D===
 
===Kalypso 1D/2D===
−
 
+
:[http://sourceforge.net/projects/kalypso/files/Kalypso/resources/animation/1d2d/1d2d1_complete.swf/download Kalypso 1D2D (Overview)]
  
 
===Kalypso Flood===
 
===Kalypso Flood===
−
 
+
:[http://sourceforge.net/projects/kalypso/files/Kalypso/resources/animation/flood/flood1.swf/download Kalypso Flood (Overview)]
  
 
===Kalypso Risk===
 
===Kalypso Risk===
−
 
+
:[http://sourceforge.net/projects/kalypso/files/Kalypso/resources/animation/risk/risk1.swf Kalypso Risk (Overview)]
−
 
+
−
==Change Logs==
+
−
:[[Development#Releases|go to Change Logs]]
+
−
 
+
−
==Flash Animations==
+
−
 
+
−
===Kalypso WSPM===
+
−
:[https://dev.bjoernsen.de/~jung/WSPM_Flash_Animation/wspm/wspm1.swf Kalypso WSPM (Overview)]
+
−
 
+
−
===Kalypso 1D/2D===
+
−
:[https://dev.bjoernsen.de/~jung/WSPM_Flash_Animation/1d2d/1d2d1_complete.swf Kalypso 1D2D (Overview)]
+
−
 
+
−
===Kalypso Flood===
+
−
:[https://dev.bjoernsen.de/~jung/WSPM_Flash_Animation/flood/flood1.swf Kalypso Flood (Overview)]
+

Latest revision as of 16:31, 23 January 2015

Contents

[edit] Online Manuals

Current Kalypso manuals are available online in the Kalypso Manual WIKI. Please find the following manuals:

[edit] PDF manuals (partly outdated)

Kalypso1D2D
KalypsoFlood
KalypsoRisk
KalypsoWSPM
KalypsoHydrology

[edit] Releases and Change Logs

See Change Logs

[edit] Flash Animations

[edit] Kalypso WSPM

WSPM (Overview)

[edit] Kalypso 1D/2D

Kalypso 1D2D (Overview)

[edit] Kalypso Flood

Kalypso Flood (Overview)

[edit] Kalypso Risk

Kalypso Risk (Overview)
Retrieved from "https://kalypso.bjoernsen.de/kalypsodev/index.php?title=Documentation&oldid=1341"
Personal tools
Namespaces

Variants
Actions
Navigation
Manuals
Toolbox