]> henry.ined.fr Git - .git/commitdiff
Summary: Some updates
authorN. Brouard <brouard@ined.fr>
Wed, 2 Sep 2015 12:30:50 +0000 (12:30 +0000)
committerN. Brouard <brouard@ined.fr>
Wed, 2 Sep 2015 12:30:50 +0000 (12:30 +0000)
src/README.txt

index e1acc9fccd9653f89b38a2dcea664cbd71d38a0e..978d69c62e93abb9864b2b1b1ba38de4eb7ca9e7 100755 (executable)
@@ -1,10 +1,6 @@
 Interpolated Marlov Chain (IMaCh program)\r
 \r
-This program is GPL licensed for the part the code that we wrote at\r
-INED. But currently (version 0.98b January 2006) maximization routines use\r
-a modified version of the patented routines from "Numerical Recipes in\r
-C". If you have the right to use the sources of their software you can\r
-get access to the source code and to the CVS tree of IMaCh.\r
+This program will be licensed under the GNU GNU GENERAL PUBLIC LICENSE.\r
 \r
 The program estimates Health Expectancies from Cross-longitudinal\r
 studies.\r
@@ -19,32 +15,64 @@ state at any age via a parametric model and estimate the parameters
 and their confidence interval by maximum likelihood. Many tables and\r
 graphs are output in HTML. Graphs are built using gnuplot.\r
 \r
-In the Windows version, gnuplot is also distributed. Version 4 of\r
-gnuplot is out since early 2004 and is used by latest version of Imach\r
-(at least version 0.38i of gnuplot is required).  IMaCh is supposed to work on\r
-Linux, Unix, MacIntosh (Panther, Tiger) and Windows (9X or NT/XP).\r
-\r
-WINDOWS\r
-On Windows it is distributed via a setup file (no more a zip file). As\r
-usual, you can put the 'imach' directory in Program Files or\r
-wherever. The directory contains at least 2 directories, 'bin' for the\r
-binaries which are imach.exe and gnuplot.exe, doc for some of the\r
+First versions appeared around year 2000. Currently (September 2015)\r
+version 0.98q5 can run on any Unix, including OS/X and on Windows 10\r
+(64bit) as well as Windows XP (32bit).\r
+\r
+Binaries are usually provided for OS/X (DMG for 64bit), Linux (rpm)\r
+and Windows installer (32 and 64bit).\r
+\r
+\r
+STRUCTURE of the binary\r
+\r
+IMaCh is a command line program (no time for a GUI) which means that\r
+it can be run on a shell by $ imach foo.imach where foo.imach is your\r
+'parameter' file which is a simple text file with a few lines that\r
+your must edit in order to describe your data as well as your model\r
+line. In this parameter file you give the name and path of your data\r
+file which is also a text file.\r
+\r
+Even if it is command line program, most operating systems offer\r
+simplifications of use:\r
+\r
+- On Windows, you can click on the imach.exe\r
+icon (which opens a DOS window) and drag your parameter file into the\r
+DOS windows and enter return. But with the newly installable version\r
+(>0.97) you can use the right click (once your mouse cursor is on an\r
+foo.imach file) to either edit the parameter file (with wordpad) or\r
+execute this parameter file via imach. At the end of the run, your are\r
+asked to enter a character and the terminal will not disappear.\r
+\r
+- On OSX, you can click on the IMaCh application and terminal will be\r
+  open: either type in the name and path of your parameter file or\r
+  drag it from the finder.\r
+\r
+The output of you run is a lot of text files which are grouped into a\r
+sub-directory having the name of your parameter file as well as an\r
+other text file foo.gp which is a gnuplot file. This gnuplot is run by\r
+imach and creates a lot of graphs from the various results text files.\r
+An other important file named foo.htm can be opened by your browser\r
+and it will display various hyperlinks to most of your results as well\r
+as your graphs.\r
+\r
+You can edit this file, customize it at your will and run it to get\r
+additional figures or modified figures to be published. Just click on\r
+gnuplot.exe and type "load foo.gp" for example.\r
+\r
+Gnuplot is a well known grapher under the GPL license too. As it is\r
+changing often, the OS/X and Windows installers are providing binaries\r
+for gnuplot 2.6.5.\r
+\r
+Since the era of 64bit processors and their wide use on OS/X and\r
+Windows 7, 8 or 10, we discovered that our usual GNU compiler were not\r
+efficient on Windows 64 and current binaries are compiled with the\r
+Intel C compiler.  On OS/X the native LLVM C compiler from Apple is\r
+very efficient too.\r
+\r
+Usually IMaCh binaries are distributed under two subdirectories, 'bin' for the\r
+binaries which are imach.exe and gnuplot.exe and 'html' for some of the\r
 documentation, and 'mytry' in order to test the program on a parameter\r
-file name 'mypar.imach'.\r
-\r
-You still can click on the imach.exe icon (which opens a DOS window)\r
-and drag your parameter file into the DOS windows and enter\r
-return. But with the newly installable version (>0.97) you can use the right\r
-click (once your mouse cursor is on an foo.imach file) to either edit the\r
-parameter file (with wordpad) or execute this parameter file via\r
-imach.\r
-If the program runs well, you get a main file (foo.htm) which can be viewed\r
-with your browser and which includes all the results.\r
-\r
-The program outputs a file named foo.gp which is executed by gnuplot\r
-in order to draw all the graphs. You can edit this file, customize it\r
-at your will and run it to get additional figures or modified figures\r
-tu be published. Jusrt click on gnuplot.exe and type "load foo.gp" for example.\r
+file named 'mypar.imach'.\r
 \r
 By default the file 'gnuplot.exe' is located on the same directory as\r
 imach and is used by imach with its absolute path. Thus, if you have\r
@@ -54,12 +82,6 @@ imach (we tried to simplify the installation process).
 If you download a newer version of IMaCh, you are supposed to Uninstall the\r
 former version with the standard Install/Uninstall process of Windows.\r
 \r
-The Windows version is compiled via cygwin (gcc -mno-cygwin -o imach\r
-imach.c). It can be used on a command line with the command "imach\r
-foo.imach". But then imach.exe must be in your path. \r
-\r
-The program can be used on Linux or on a MacIntosh.\r
-\r
 Enjoy (?) using IMaCh.\r
 \r
 You may subscribe to imach-users@listes.ined.fr by sending a mail at\r
@@ -70,8 +92,13 @@ Other comments are included on the Wiki server
 http://euroreves.ined.fr/imach/wiki, please use it ask questions too.\r
 \r
 Nicolas Brouard (brouard at ined point fr)\r
-Agnès Lièvre (lievre chez ined dot fr)\r
-Christopher Heathcote\r
+Institut national d'études démographiques\r
+133 Boulevard Davout\r
+75014 Paris\r
+\r
+Earlier versions were also written by \r
+Agnès Lièvre (former PHD student at INED)\r
+Christopher Heathcote (ANU)\r
 \r
  \r
 \r