search

JuliaDynamics / TransitionsInTimeseries.jl

Transition Indicators / Early Warning Signals / Regime Shifts / Change Point Detection
MIT License
18 stars 5 forks source link

First draft for JOSS paper #70

Closed JanJereczek closed 6 months ago

JanJereczek commented 6 months ago

This PR proposes a first draft for the JOSS paper describing the package. The JOSS guideline states that the paper should be between 250-1000 words. Authors submitting papers significantly longer than 1000 words may be asked to reduce the length of their paper. We are at about 1,500 words, which might not be a big issue but needs to be discussed.

The code used to generate the two figures of the paper are provided in paper/code/ and the figures in paper/figures. The first figure requires a .csv file, which is not included in the PR since we should include it in the genral repo of JuliaDynamics. The second figure is a comparison to the run time of ewstools, as assessed in paper/code/ewstools-tuto-1.py.

@Datseris, I suggest we have a call to talk about the draft :) Also, at some point you will need to put your affiliation and your funding.

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (b1d3387) 36.42% compared to head (32ad0fe) 81.36%. Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #70 +/- ## =========================================== + Coverage 36.42% 81.36% +44.94% =========================================== Files 18 16 -2 Lines 442 365 -77 =========================================== + Hits 161 297 +136 + Misses 281 68 -213 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JanJereczek commented 6 months ago

Hi @Datseris, thanks a lot for your corrections :) I applied all of them (except for one I that answered to, see above). In particular, I reformulated the versatility section and moved it for a better flow of explanations. I hope you'll like it!