[BACK]Return to README.txt CVS log [TXT] [DIR] Up to [Local Repository] / imach / src

Diff for /imach/src/README.txt between versions 1.4 and 1.9

version 1.4, 2015/09/02 12:30:50 version 1.9, 2022/03/15 18:40:36
Line 1 Line 1
   Version IMaCh 0.99
   
 Interpolated Marlov Chain (IMaCh program)  Interpolated Marlov Chain (IMaCh program)
   
 This program will be licensed under the GNU GNU GENERAL PUBLIC LICENSE.  This program is licensed under the GNU GNU GENERAL PUBLIC LICENSE.
   
 The program estimates Health Expectancies from Cross-longitudinal  The program estimates Life Expectancies from Cross-longitudinal
 studies.  studies as well as age-specific forward and backward prevalences in each state.
 The main publication is Lievre, A. Brouard. N, Heathcote  The main publications are:
 Ch. Estimating Health Expectancies from Cross-longitudinal surveys,  (1) Lièvre, A. Brouard. N, Heathcote Ch. Estimating Health
 Mathematical Population Studies, 10(1), 2003, pp. 1-52.  Expectancies from Cross-longitudinal surveys, Mathematical Population Studies, 10(1), 2003, pp. 1-52.
   (2) Nicolas Brouard, 2019, "Theory and applications of backward probabilities and prevalences in cross-longitudinal surveys". In: Arni S. R. Srinivasa Rao (Ed.) and C.R. Rao (Ed.), Handbook of Statistics.
   Integrated population biology and modeling, Part B, Elsevier, p. 435-486.
   http://hdl.handle.net/20.500.12204/AWltfxMuXMQCvuZmm9UI
   
 To be brief, for each people interviewed we need the age and health  To be brief, for each people interviewed we need the age and
 status at each interview. Also the month and year of death should be  state at each interview. Also the month and year of death should be
 known as for birth.  We model the probability to be observed in any  known as for birth.  We model the probability to be observed in any
 state at any age via a parametric model and estimate the parameters  state at any age via a parametric model and estimate the parameters
 and their confidence interval by maximum likelihood. Many tables and  and their confidence interval by maximum likelihood. Many tables and
 graphs are output in HTML. Graphs are built using gnuplot.  graphs are output in HTML. Graphs are built using gnuplot.
   
 First versions appeared around year 2000. Currently (September 2015)  First versions appeared around year 2000. Currently (May 2019)
 version 0.98q5 can run on any Unix, including OS/X and on Windows 10  version 0.99r19 can run on any Unix, including OS/X and on Windows 10
 (64bit) as well as Windows XP (32bit).  (64bit) as well as Windows XP (32bit).
   
 Binaries are usually provided for OS/X (DMG for 64bit), Linux (rpm)  Binaries are usually provided for OS/X (DMG for 64bit), Linux (rpm)
Line 26  and Windows installer (32 and 64bit). Line 31  and Windows installer (32 and 64bit).
 STRUCTURE of the binary  STRUCTURE of the binary
   
 IMaCh is a command line program (no time for a GUI) which means that  IMaCh is a command line program (no time for a GUI) which means that
 it can be run on a shell by $ imach foo.imach where foo.imach is your  it can be run on a shell by "$ imach foo.imach" where foo.imach is your
 'parameter' file which is a simple text file with a few lines that  'parameter' file which is a simple text file with a few lines that
 your must edit in order to describe your data as well as your model  your must edit in order to describe your data as well as your model
 line. In this parameter file you give the name and path of your data  line. In this parameter file you give the name and path of your data
Line 35  file which is also a text file. Line 40  file which is also a text file.
 Even if it is command line program, most operating systems offer  Even if it is command line program, most operating systems offer
 simplifications of use:  simplifications of use:
   
 - On Windows, you can click on the imach.exe  - On Windows, you can click on the imach.exe icon (which opens a DOS
 icon (which opens a DOS window) and drag your parameter file into the  window) and drag your parameter file into the DOS windows and enter
 DOS windows and enter return. But with the newly installable version  return. You can use the right click (once your mouse cursor is on an
 (>0.97) you can use the right click (once your mouse cursor is on an  foo.imach file) to either edit the parameter file (with notepad) or
 foo.imach file) to either edit the parameter file (with wordpad) or  
 execute this parameter file via imach. At the end of the run, your are  execute this parameter file via imach. At the end of the run, your are
 asked to enter a character and the terminal will not disappear.  asked to enter a character and the terminal will not disappear.
   
 - On OSX, you can click on the IMaCh application and terminal will be  - On OSX, you can click on the IMaCh application and a terminal window will be
   open: either type in the name and path of your parameter file or    opened: either type in the name and path of your parameter file or
   drag it from the finder.    drag it from the finder.
   
 The output of you run is a lot of text files which are grouped into a  The output of your run consists in many text files which are grouped
 sub-directory having the name of your parameter file as well as an  into a sub-directory having the same name as of your parameter
 other text file foo.gp which is a gnuplot file. This gnuplot is run by  filename 'foo'. In addition, you will find two other important files
 imach and creates a lot of graphs from the various results text files.  on the same directory as your parameter file:
 An other important file named foo.htm can be opened by your browser  
 and it will display various hyperlinks to most of your results as well  -1- a text file named 'foo.gp' which is a gnuplot file. This gnuplot
 as your graphs.  is automatically runned by imach in order to create the graphs from
   the various result text files.
 You can edit this file, customize it at your will and run it to get  
 additional figures or modified figures to be published. Just click on  You can edit this gnuplot file, customize it at your will and run it
 gnuplot.exe and type "load foo.gp" for example.  to get additional figures or modified figures to be published. Just
   click on gnuplot executable and type "load foo.gp" for example.
   
 Gnuplot is a well known grapher under the GPL license too. As it is  Gnuplot is a well known grapher under the GPL license too. As it is
 changing often, the OS/X and Windows installers are providing binaries  changing often, the OS/X and Windows installers are providing binaries
 for gnuplot 2.6.5.  for gnuplot 2.6.5.
   
   -2- a text file named 'foo.htm' which is an html file. It can be
   opened by your browser and it will display various hyperlinks to most
   of your results as well as your graphs.
   
   
 Since the era of 64bit processors and their wide use on OS/X and  Since the era of 64bit processors and their wide use on OS/X and
 Windows 7, 8 or 10, we discovered that our usual GNU compiler were not  Windows 7, 8 or 10, we discovered that our usual GNU compiler were not
 efficient on Windows 64 and current binaries are compiled with the  efficient on Windows 64 and current binaries are compiled with the
 Intel C compiler.  On OS/X the native LLVM C compiler from Apple is  Intel C compiler.  On OS/X the native LLVM C compiler from Apple is
 very efficient too.  very efficient too.
   
 Usually IMaCh binaries are distributed under two subdirectories, 'bin' for the  Usually IMaCh binaries are distributed under two subdirectories, 'bin'
 binaries which are imach.exe and gnuplot.exe and 'html' for some of the  for the binaries which are imach.exe and gnuplot.exe and 'html' for
 documentation, and 'mytry' in order to test the program on a parameter  some of the documentation, and 'mytry' in order to test the program on
 file named 'mypar.imach'.  a parameter file named 'mypar.imach'. In order to use IMaCh, you need
   two text files, one is called the parameter file with extension .imach
   or .txt which contains few lines and the data file which can be juge
   according to the number of people surveyed.  You can find in the
   subdirectory doc of your installed package, some testing files like
   biaspar.imach and mypar.imach . If you edit such a parameter file, you
   will see a link to the data file, for exemple data1.txt . You can copy
   both files, parameter and data file into a private directory. Then run
   imach and drag the parameter file.
   
   You can access to the main IMaCh server at
   http://euroreves.ined.fr/imach but the main documentation is a wiki at
   http://euroreves.ined.fr/imach/wiki .  You can download the latest versions
   at http://euroreves.ined.fr/imach/Download .
   
 By default the file 'gnuplot.exe' is located on the same directory as  By default the file 'gnuplot.exe' is located on the same directory as
 imach and is used by imach with its absolute path. Thus, if you have  imach and is used by imach with its absolute path. Thus, if you have
Removed from v.1.4  
changed lines
  Added in v.1.9

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>