156
edits
User:Josiah425:TISEAN Package: Difference between revisions
Jump to navigation
Jump to search
→General division
| Line 1: | Line 1: | ||
= TISEAN Package Porting Project = | = TISEAN Package Porting Project = | ||
== Goal of the project == | |||
The goal of this project is not to port the entire TISEAN package to octave. That would be a desired outcome though it might not be feasible within the time constraints. The goal of this project is to give the TISEAN package a solid start and to port as many functions as possible to create a solid foundation for the future. | |||
== General division == | == General division == | ||
As the TISEAN package consists of 74 programs 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') -- there are 5 programs in this class | |||
# c programs which also need to be linked to oct files (an example is 'ghkss') -- there are 41 programs in this class | |||
# the FORTRAN ones that need to be linked to oct files (an example of such a program is 'project') -- there are 28 programs in this class | |||
They are ordered so that according to my estimates the difficulty rises with the number. This is because typecasting and implicit typing (which is included in most of the FORTRAN files in the TISEAN library) can be problematic sometimes. | |||
Apart from the qualitative division I propose a work oriented division, in which each subpart can be tackled separately and create an entity in-and-of-itself. I chose to work along the lines of the articles about implementations of nonlinear timeseries included in the documentation. This article discusses various algorithms and what certain programs mean. It can be found [http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/docs/chaospaper/TiseanHTML.html| here]. I will discuss in which order I would like to port various topics in this and where my work currently stands. | |||
==== Nonlinear noise reduction ==== | ==== 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: | 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: | ||
| Line 32: | Line 41: | ||
* Linkable to FORTAN (surrogates, randomize , timerev) | * Linkable to FORTAN (surrogates, randomize , timerev) | ||
This stage should take me about 3 days to complete. | This stage should take me about 3 days to complete. | ||
=== Notes | === Notes on time estimates === | ||
Totaling up the above estimates it should take me 6 weeks to complete my task as outlined above. I do think my time estimates are rather conservative, but I would rather work on other programs (the documentation contains another article located [http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/docs/surropaper/Surrogates.html| here]) than to be overwhelmed with the work and try to rush trough. As I am not fully familiar with the mathematical concepts discussed within these articles I want to make sure that I reduce the possibility of error when linking programs to octave to a minimum. If I vastly overestimated the time I will need to port those functions I intend to finish the 'Visualization, non-stationary' section of the work on nonlinear timeseries and then proceed to programs from the 'Surrogate time series article'. | Totaling up the above estimates it should take me 6 weeks to complete my task as outlined above. I do think my time estimates are rather conservative, but I would rather work on other programs (the documentation contains another article located [http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/docs/surropaper/Surrogates.html| here]) than to be overwhelmed with the work and try to rush trough. As I am not fully familiar with the mathematical concepts discussed within these articles I want to make sure that I reduce the possibility of error when linking programs to octave to a minimum. If I vastly overestimated the time I will need to port those functions I intend to finish the 'Visualization, non-stationary' section of the work on nonlinear timeseries and then proceed to programs from the 'Surrogate time series article'. | ||
== Details of work on each program == | |||
* FORTRAN linking | |||
For each FORTRAN program that I intend to link to a oct-file I intend to: | |||
# Strip the program of its input validation and transform it into a subroutine | |||
I | # Create a .cc program (compiled into an oct-file) that will launch the stripped FORTRAN subroutine; this .cc program will also not contain input validation, it will be for internal use only | ||
# | # Create a m-file that will perform input validation and launch the .cc and contain usage documentation | ||
# | * C linking | ||
I intend to do here something similar to the FORTRAN programs, although, it might be better to not create any extra m-files and incorporate the program's existing input validation into the .cc file. This might be a desired course of action. I will make a decision once I complete one such linking program. | |||
* Reimplementing in mfile | |||
This is quite straightforward, although it is important not to make a mistake while taking this approach. | |||
== Where I intend to start == | == Where I intend to start == | ||