2019 July release
Closed this issue · 10 comments
It is probably time for a new release (see #88) - sometime towards the end of July 2019.
This issue is to discuss what we want to include (or not) before the release.
@aewallin to-do list
- recall and document the release-process on github/pypi
- add real-time ADEV (etc.) functions that operate on a stream of samples.
- readthedocs build fixed (was not updated in 4 months or so..)
issues (to be) fixed:
- #88 pypi install broken for python3(?)
- #70 kw-args for Plot()
- #74 length of noise.Pink()
- #21 mtotdev() htotdev() are very slow
- #51 enabled cs-dataset test again. it is quite slow but maybe it's OK anyway.
- #82 mtie() consumes too much memory
General to-do list:
- #97 save dataset results to file
-
decide on datetime functionality(#87) - leaving them out - add documentation on different datetime alternatives - improve documentation (e.g. #55)
please add your ideas/comments/to-do-lists below - thanks.
idea maybe: make the /frequency2phase()/ function capable of handling data with holes (represented by NaN).
Do you have a particular paper/reference in mind for different ways of handling this? It seems there are many ways: just ignoring gaps, filling them with a linear interpolation between existing datapoints, filling them with some noise model estimated from valid datapoints, etc.
I agree with @ffrank14. Maybe the input can be in two columns: MJD and data, and then the frequency2phase()/phase2frequency() function can detect gaps. Stable32 gives several ways to deal with these gaps: e.g. gaps are ignored in ADEV, while gaps are filled in MDEV. But I found an issue: when processing data with gaps, the ADEV results are worse (ADEV values are larger) in the case of firstly phase2freq conversion than direct calculation on phase data. That might be related to the gaps ignorance. If this issue can be improved, that would be nice.
2019.07.rc1 is now tagged and uploaded to pypi:
https://pypi.org/project/AllanTools/2019.7rc1/
the instructions say to test with "pip install AllanTools==2019.7rc1"
If you could please test within one week and report any potential problems - thanks! (I'll try to release the final version August 3rd-4th)
Things that we did not have time to fix for this release are now moved to #101
I plan to tag the 2019.07 release on about August 4th
FWIW: installs smoothly on a win10 / python 3.6.6 environment I don't usually use for development.
However one of the tests fails: write_results in test_dataset.py.
PermissionError: [Errno 13] Permission denied: 'C:\\Users\\FREDER~1.MEY\\AppData\\Local\\Temp\\tmpybjzk6hn'
The function itself works if you use it as intended, I think it is just an issue with Windows handling the temporary file creation in the test.
#102 is now some (initial) steps towards getting travis to test on OSX and WIN also.
@fmeynadier travis now catches the problem with tempfile on windows, see #103