TISEAN Package Porting Project
AS the TISEAN package consists of 74 programs it needs to be divided into subparts that can be tackled separately and create a entity in-and-of-themselves. I chose to work along the lines of how the documentation introduces programs in its package. This representation can be found here. I will discuss in which order I would like to port various topics in the documentation and where my work currently stands.
Nonlinear noise reduction
This is the first topic I chose. It is because it contains programs from all three categories. It is also relatively small -- it contains 3 programs: project, lazy, ghkss. I have chosen to further implement addnoise and henon, to demonstrate how project and ghkss work. Thus this topic contains programs from each category:
- Re-implementable in mfile (henon)
- Linkable to FORTRAN (project, addnoise, lazy)
- Linkable to c (ghkss)
I have already started work on this stage. My progress can be viewed at https://bitbucket.org/josiah425/tisean. So far I have implemented addnoise, project and re-implemented henon as an mfile. As most work on this topic has been completed I estimate that finishing it up around 2 days -- I estimate 1 day per function (that includes documentation and testing).
Phase space representation
This is the next topic that needs to be implemented. This is because it contains programs (especially 'delay') that are used to visualize data. Whenever an example is given in the package the resulting data is routed through 'delay' before it is plotted. Apart from delay it also contains other functions that can divided into the following categories:
- Linkable to FORTRAN (autocorr, pc)
- Linkable to c (delay, corr, mutual, false_nearest, pca)
Assuming around a day for each function (with testing and documenting the usage) I assume this stage will take a little over a week.
This seems like a reasonable next step. It consists of the following programs:
Porting of the TISEAN package has a couple parts. First part is making the FORTRAN and c programs accessible to Octave. Second part would be creating makefiles and putting all that code in a neat package. I have divided the first part into three sub-parts:
- FORTRAN ones that can be re-implemented easily in m-files (a good example of such a program is 'henon')
- the FORTRAN ones that need to be linked to oct files (an example of such a program is 'project')
- c programs which also need to be linked to oct files.
As linking FORTRAN code to oct code is most difficult of those three tasks, there are 28 in this category. If it is more difficult than I expect I will move some of the easier programs into the m-file category.
Next there are the programs in the Tisean package which can be ported to m-files easily. This is not as difficult a task as linking FORTRAN code to oct files. I have put 5 programs in this category. Last but not least, I have 41 programs in C that need to be linked to Oct files. There are 41 programs in this category.
My plan is to try to work with sections of the library at the time. As described below, I intend to begin with the programs connected to Nonlinear noise reduction. The goal is to then document all those files and create a usable package. After finishing those functions I intend to move to another area of the TISEAN package and add programs that actually make a whole. As it is hard to precisely estimate how much time porting the entire TISEAN package will take, I can make small steps that will in-and-of-themselves form a whole.
Thus every milestone will be finishing each section of the TISEAN package.
I would like to tackle them in the following order:
- Nonlinear noise reduction
- Testing for nonlinearity
- Nonlinear prediction
- Lapunov Exponents
- Dimensions and entropies
Once those are completed I will look at other programs to be ported. The idea though, is to focus on getting a solid start for porting this library.
Where I intend to start
I will start with a small step of porting all of the functions needed for Nonlinear noise reduction. The functions I will need is: henon (for generating data), addnoise, ghkss and project. They cover all of the three categories I talked about in the first section. I have already reimplemented henon in m-file, it is accessible here. Both addnoise and project are in FORTRAN and need to be linked to C++ files and compiled into oct files. Lastly, ghkss is implemented in c and needs to be linked to a C++ oct file.
Where I am at
I have already ported henon. I have also been able to link with FORTRAN programs addnoise and project. My progress can be viewed here.
Explanation of what I want to do with each file
Each FORTRAN file that need to be linked to an Oct file needs work done on it. I plan to take the following steps with each FORTRAN program:
- Change the FORTRAN program into a subroutine. The arguments of this subroutine will be the parameters that this program would have normally read from the user during execution.
- Move input parsing and validation from the FORTRAN files to the .cc file which will link the respective fortran file to it. This will make the fortran subroutines 'dumb' and unable to distinguish between good and bad data.
- Eliminate all file inputs and outputs. The fortran programs write and read data to/from files. This is unnecessary in Octave, as data can be supplied and retrieved to/from these subroutines directly via oct files.
- Test the oct file against the original library to ensure I didn't make mistakes.
I plan to do similar steps for the c files. I believe this stage will be easier as the c code is much better organized and eliminating input validation & parsing, file inputs and outputs should be a much easier task.