Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JOSS] docs per version hosted by read the docs #451

Closed
vergauwenthomas opened this issue Feb 28, 2024 · 1 comment · Fixed by #453
Closed

[JOSS] docs per version hosted by read the docs #451

vergauwenthomas opened this issue Feb 28, 2024 · 1 comment · Fixed by #453
Assignees
Labels
documentation Improvements or additions to documentation Priority This issue has priority

Comments

@vergauwenthomas
Copy link
Owner

See comment by @ashwinvis:

@vergauwenthomas I am now fairly confident that the software works as you have described.

I have a few requests regarding the article, particularly the section Technical implementation.

Further reading and citations needed here
Since MetObs-Toolkit implements quite a few methods, it would be important to link to other sources which may describe them in detail. If you think that these methods might be subject to change, it might be sufficient to cite the references in the online documentation and link this software paper to the documentation instead. See how scikit-image does it.

“55 to examine data types, irregular timestamps, max-min thresholds, repetitions criteria, spike tests, allowed variation in time windows and spatial tests” (Vergauwen et al., 2024, p. 3) (pdf)

These, IMHO, are quite involved methods. What are the formal basis behind these QC methods or are they based on intuition? Some reuses TITAN (titanlib) while the rest are implemented from the scratch (which means citing TITAN alone will not be sufficient). .

“59 ... gap filling is applied by using interpolation methods” (Vergauwen et al., 2024, p. 3) (pdf)

Gap filling and bias correction is another involved topic. What is the basis behind the methods used? Further reading and citations needed here.


When a reference is made to the documentation, there must be an online version-tracking of the documentation. In order to do that:

  • Build documentation on Read the docs
  • Build the docs for multiple versions (latest + major versions)
  • Update links to the documentation (point to rtd instead of the github.io)
  • adjust the main workflow (is there a rtd hook to implement?)
@vergauwenthomas vergauwenthomas self-assigned this Feb 28, 2024
@vergauwenthomas vergauwenthomas added Priority This issue has priority documentation Improvements or additions to documentation labels Feb 28, 2024
@vergauwenthomas
Copy link
Owner Author

Ref: openjournals/joss-reviews#5916

@vergauwenthomas vergauwenthomas changed the title [JOSS] refer to documentation in the paper [JOSS] docs per version hosted by read the docs Feb 28, 2024
@vergauwenthomas vergauwenthomas linked a pull request Feb 28, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Priority This issue has priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant