darogan / particlestats Goto Github PK

The following files are used by the web interface but are not present in the repository or any of the release tarballs:

• Images/heckert_gnu.small.png
• Images/PS_Logo_Simple_100px.png
• Images/compare_logo_100px.png
• Images/directionality_logo_100px.png
• Images/kymograph_logo_100px.png
• Images/PS_Logo_Simple_100px.png

• Split into a User Guide and Install Guide
• Write in markdown format not PDF
• Include documentation of new features
• Include details of Web Interface Install #10

1. it uses backticks instead of system() with a list of arguments in order to collect output
2. it uses the same filenames as the ones uploaded (I'm guessing it makes more sense to interpret)
3. only removes slashes from the filename

The above means that a file named foo $(do something bad).xls will do something bad. Limited to what the user that runs the cgi script can do.

The python packages requires a file scripts/ParticleStats_TrackCompare.py:

    scripts=[ "scripts/ParticleStats_TrackCompare.py", "scripts/ParticleStats_Compare.py", "scripts/ParticleStats_Directionality.py", "scripts/ParticleStats_Kymographs.py", "scripts/ParticleStats_ROI.py" ],

Which is not present on the package:

$ md5sum ParticleStats-0.3.tar.gz 
5b22ebec256a812e237d5122127cbde8  ParticleStats-0.3.tar.gz
$ tar -tvzf ParticleStats-0.3.tar.gz | grep TrackCompare
$

or the whole history of the repository:

$ git log --all --pretty=format: --name-only --diff-filter=A | grep TrackCompare
[again no output]

Failure at the getopts stage for ParticleStats::Directinality

Because of the way the command is generated and called, the web interface fails when there's whitespace. Currently code does something like:

my $command = "python script.py -in $filename"
my $output = `$command`

The easiest way out is to simply quote $filename but that will cause problems if the filename has quotes. A good way out is to use system() but then it doesn't capture stdout. A better way out would be to use IPC::Open2 but that complicates things. An easier way out would be too use a hardcoded filename when uploading the filename but then the output will make less sense to the user.

Wrap ParticleStats in a Docker container to remove the need to install the 3rd party dependencies

Make the setting of the install paths more simple for installing the web interface

• Create HTML report with inline images and HighCharts
• Bypass requirement for file names based on input file

@carandraug this should help address #12 #14

At the moment there are two web interfaces to ParticleStats, ParticleStats_Web.pl and ParticleStats_WebStats.pl. However, I couldn't find any comment on the purpose of each and they are not mentioned on the pdf manual.

Is any of them deprecated? Or any of them in a work in progress?

Not really an issue but while auditing the code and trying to make sense of the web interface, I made a lot of changes which I hope make the code more readable. It also removes a lot of unused variables, warnings about use of undef variables, etc.

Please review the commits on my clone and merge as you see fit. Would be nice if this would be done before the changes to fix issue #11 and #12 which would complicate the merge.

Colour the windmap squares by the speeds of the trails contained within

The file ParticleStats_linRegressFit.c refered on setup.py of the python package

module1 = Extension('ParticleStats_linRegressFit',
                    sources = ['ParticleStats_linRegressFit.c'])

is not present on the tarball.

$ md5sum ParticleStats-0.3.tar.gz 
5b22ebec256a812e237d5122127cbde8  ParticleStats-0.3.tar.gz