source reformatting, typo fix
[iDMC.git] / README
blobd0912209a3f14cbc725076b121da1467b1bb4028
1 =======================================
2 1. iDmc -  Dynamical Model Calculator
3 =======================================
5 This is iDMC the interactive Dynamical Model Calculator simulates and
6 performs graphical and numerical analysis of systems of differential
7 and difference equations.
9 iDmc is Copyright (C) 2004-2007 Marji Lines and Alfredo Medio.
11 iDmc was designed and written by Daniele Pizzoni <auouo@tin.it>, and 
12 subsequently modified by A. Grigoriev and A. F. Di Narzo.
14 iDmc was developed within a research project financed by the Italian
15 Ministry of Universities, the Universities of Udine and Ca'Foscari of
16 Venice, the Friuli-Venezia Giulia Region.
18 This program is free software; you can redistribute it and/or modify
19 it under the terms of the GNU General Public License version 2 as published by
20 the Free Software Foundation.
22 This program is distributed in the hope that it will be useful, but
23 WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25 General Public License for more details.
27 ============================
28 2. What's new in this 2.x.x
29 ============================
30 In this version there are some new features w.r.t. version 1.9.3.
32 * Data exporting
33 - ability to export trajectory, Lyapunov exponents and basins of attraction data
34 to external files, ready to be opened with the software of your choice
36 * Basins of attraction
37 - added a new faster algorithm for basins of attractions
38 - added full colors customization in basin of attraction plots, with possibility
39   of saving settings between one session and another
41 * Random numbers
42 - added many new random distributions
43 - added a whole new random number generator with good statistical properties
44 - added possibility of setting RNG seed for reproducibility of results
46 * Periodic cycles
47 - added cycles classification based on stability
48 - improved input mask
50 * Error messages
51 - more detailed syntax and runtime LUA error messages reporting
53 * Bug fixes
54 - misc problems in Lyapunov exponent plots with diverging exponents
56 * Invisible to user
57 - removed C code from the software. Now iDMC (i.e., GUI and plotting)
58   is written entirely in Java, while using a separate specialized library, 
59   idmclib, for actual numerical analysis
60 - upgraded external libraries to more recent versions
62 ==================================
63 3. Other software included in iDmc
64 ==================================
66 iDmc includes or may include (depending on how you compile it) parts
67 from different free software packages distributed with GPL-compatible
68 licenses. You can find copies of the licenses under the directory
69 doc/licenses. A comprehensive list follows.
71 idmclib
72 -------
74 The iDMC C support library
76 Copyright (C) 2006-2007 Marji Lines and Alfredo Medio.
78 http://code.google.com/p/idmclib
80 GPL v.2 licensed
83 JFreeChart
84 ----------
86 A free Java class library for producing charts.
88 (C)opyright, 2000-2003, by Object Refinery Limited and Contributors.
90 http://www.jfree.org/jfreechart/index.html
92 LGPL licensed
95 JFreeCommon
96 -----------
98 A free general purpose Java class library
100 (C)opyright, 2000-2003, by Object Refinery Limited and Contributors.
102 http://www.jfree.org/jcommon/index.html
104 LGPL licensed
107 JGoodies Forms
108 --------------
110 A framework to layout and implement elegant Swing panels quickly and
111 consistently.
113 Copyright (c) 2003 JGoodies Karsten Lentzsch.
115 www.JGoodies.com/
117 BSD licensed
120 Jakarta log4j
121 -------------
123 A logging package. With log4j is possible to enable logging at runtime
124 without modifying the application binary.
126 Copyright 1999-2003, Apache Software Foundation
128 Licensed with The Apache Software License, Version 1.1
131 ===============
132 4. Availability
133 ===============
135 iDMC is distributed in precompiled binary and source form.
136 Self-installing binaries are distributed for win32 and linux-i386 OS.
137 Istructions are boundled for compiling iDMC yourself for other 
138 platforms.
140 ===============
141 5. Installation
142 ===============
144 Execute "java -jar iDmc-xx.xx.xx-install.jar" to run the installer under Windows
145 and i386 GNU/Linux.
146 See COMPILING to install from sources.
148 =================
149 6. Reporting Bugs
150 =================
152 Send mail to idmc-discussion@googlegroups.com to report bugs and/or request help.