search

chenyangkang / stemflow

A Python Package for Adaptive Spatio-Temporal Exploratory Model (AdaSTEM)
https://chenyangkang.github.io/stemflow/
MIT License
15 stars 1 forks source link

[JOSS review] Documentation revision #25

Closed chenyangkang closed 8 months ago

chenyangkang commented 8 months ago

This issue is to solve the problem suggested by [at]jedalong (https://github.com/openjournals/joss-reviews/issues/6158)

What is the difference between temporal_step and temporal_bin_interval? I didnt follow the whole 'sliding' window part of this are they bins/blocks or a moving window?

Documentation Notes: Rephrase: stemflow have 4 important gridding parameters. Actually only two: The maximum grid length, and the minimum grid length. It can be separately set by longitude and latitude, and that will be 4.

TODO:

  1. Add documentation on sliding window.
  2. Add docs on the difference between temporal_step and temporal_bin_interval.
  3. Revise the gridding params docs.
chenyangkang commented 8 months ago

Progress:

  1. I add figure and documentations to AdaSTEM demo documentation
  2. Users can now see init docs for class AdaSTEMClassifier and AdaSTEMRegressor. The two variables are explained in the function docs. Besides, I add brief inline comment at homepage and demo.
  3. Rephrased.