stemflow :bird:

stemflow logo

A Python Package for Adaptive Spatio-Temporal Exploratory Model (AdaSTEM)

GitHub PyPI version PyPI downloads Anaconda version Anaconda downloads GitHub last commit

Documentation :book:

Installation :wrench:

pip install stemflow

To install the latest beta version from github:

pip install stemflow@git+https://github.com/chenyangkang/stemflow.git

Or using conda:

conda install -c conda-forge stemflow

Brief introduction :information_source:

stemflow is a toolkit for Adaptive Spatio-Temporal Exploratory Model (AdaSTEM [1, 2]) in Python. Typical usage is daily abundance estimation using eBird citizen science data (survey data).

stemflow adopts "split-apply-combine" philosophy. It

Splits input data using Quadtree or Sphere Quadtree.
Trains each spatiotemporal split (called stixel) separately.
Aggregates the ensemble to make the prediction.

The framework leverages the "adjacency" information of surroundings in space and time to model/predict the values of target spatiotemporal points. This framework ameliorates the long-distance/long-range prediction problem [3], and has a good spatiotemporal smoothing effect.

For more information, please see an introduction to stemflow and learning curve analysis

Model and data :slot_machine:

Main functionality of `stemflow`	Supported indexing	Supported tasks
:white_check_mark: Spatiotemporal modeling & prediction	:white_check_mark: User-defined 2D spatial indexing (CRS)	:white_check_mark: Binary classification task
:white_check_mark: Calculate overall feature importances	:white_check_mark: 3D spherical indexing	:white_check_mark: Regression task
:white_check_mark: Plot spatiotemporal dynamics	:white_check_mark: User-defined temporal indexing	:white_check_mark: Hurdle task (two step regression – classify then regress the non-zero part)
	:white_check_mark: Spatial-only modeling
For details see AdaSTEM Demo	For details and tips see Tips for spatiotemporal indexing	For details and tips see Tips for different tasks

Supported data types	Supported base models
:white_check_mark: Both continuous and categorical features (prefer one-hot encoding)	:white_check_mark: sklearn style `BaseEstimator` classes (you can make your own base model), for example here
:white_check_mark: Both static (e.g., yearly mean temperature) and dynamic features (e.g., daily temperature)	:white_check_mark: sklearn style Maxent model. Example here.
For details and tips see Tips for data types	For details see Base model choices

Usage :star:

Use Hurdle model as the base model of AdaSTEMRegressor:

from stemflow.model.AdaSTEM import AdaSTEM, AdaSTEMClassifier, AdaSTEMRegressor
from stemflow.model.Hurdle import Hurdle
from xgboost import XGBClassifier, XGBRegressor

## "hurdle in Ada"
model = AdaSTEMRegressor(
    base_model=Hurdle(
        classifier=XGBClassifier(tree_method='hist',random_state=42, verbosity = 0, n_jobs=1),
        regressor=XGBRegressor(tree_method='hist',random_state=42, verbosity = 0, n_jobs=1)
    ),                                      # hurdel model for zero-inflated problem (e.g., count)
    save_gridding_plot = True,
    ensemble_fold=50,                       # data are modeled 50 times, each time with jitter and rotation in Quadtree algo
    min_ensemble_required=30,               # Only points covered by > 30 ensembles will be predicted
    grid_len_upper_threshold=25,            # force splitting if the grid length exceeds 25
    grid_len_lower_threshold=5,             # stop splitting if the grid length fall short 5         
    temporal_start=1,                       # The next 4 params define the temporal sliding window
    temporal_end=366,                            
    temporal_step=20,                       # The window takes steps of 20 DOY (see AdaSTEM demo for details)
    temporal_bin_interval=50,               # Each window will contain data of 50 DOY
    points_lower_threshold=50,              # Only stixels with more than 50 samples are trained and used for prediction
    Spatio1='longitude',                    # The next three params define the name of 
    Spatio2='latitude',                     # spatial coordinates shown in the dataframe
    Temporal1='DOY',
    use_temporal_to_train=True,             # In each stixel, whether 'DOY' should be a predictor
    n_jobs=1,
    random_state=42
)

Fitting and prediction methods follow the style of sklearn BaseEstimator class:

## fit
model = model.fit(X_train.reset_index(drop=True), y_train)

## predict
pred = model.predict(X_test)
pred = np.where(pred<0, 0, pred)
eval_metrics = AdaSTEM.eval_STEM_res('hurdle',y_test, pred_mean)
print(eval_metrics)

Where the pred is the mean of the predicted values across ensembles.

See AdaSTEM demo for further functionality.
Besides, stemflow also support lazy loading and database query to reduce memory load during parallel computing.

Plot QuadTree ensembles :evergreen_tree:

model.gridding_plot
# Here, the model is a AdaSTEM class, not a hurdle class

QuadTree example

Here, each color shows an ensemble generated during model fitting. In each of the 10 ensembles, regions (in terms of space and time) with more training samples were gridded into finer resolution, while the sparse one remained coarse. Prediction results were aggregated across the ensembles (that is, in this example, data were modeled 10 times).

If you use SphereAdaSTEM module, the gridding plot is a plotly generated interactive object by default:

See SphereAdaSTEM demo and Interactive spherical gridding plot.

Example of visualization :world_map:

Daily Abundance Map of Barn Swallow

GIF visualization

See section AdaSTEM demo for how to generate this GIF.

Citation

Chen et al., (2024). stemflow: A Python Package for Adaptive Spatio-Temporal Exploratory Model. Journal of Open Source Software, 9(94), 6158, https://doi.org/10.21105/joss.06158

@article{Chen2024, 
  doi = {10.21105/joss.06158}, 
  url = {https://doi.org/10.21105/joss.06158}, 
  year = {2024}, 
  publisher = {The Open Journal}, 
  volume = {9}, 
  number = {94}, 
  pages = {6158}, 
  author = {Yangkang Chen and Zhongru Gu and Xiangjiang Zhan}, 
  title = {stemflow: A Python Package for Adaptive Spatio-Temporal Exploratory Model}, 
  journal = {Journal of Open Source Software} 
}

Contribute to stemflow :purple_heart:

We welcome pull requests. Contributors should follow contributor guidelines.

Application-level cooperation is also welcomed. We recognized that stemflow may consume large computational resources especially as data volume boosts in the future. We always welcome research collaboration of all kinds.

References:

Metadata

Release files for stemflow 1.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stemflow 1.1.6
File	Size	Uploaded
stemflow-1.1.6.tar.gz	85.2 kB	Oct 31, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for stemflow 1.1.6
File	Interpreter	ABI	Platform	Reset
stemflow-1.1.6-py3-none-any.whl 95.2 kB Oct 31, 2025	Python 3	none	any	Details

Total release size: 180.3 kB

Release files / stemflow-1.1.6.tar.gz

Download URL	stemflow-1.1.6.tar.gz
Size	85.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`b2c02b502485123d539242d3abedc4a106561c30405d8070716c947c6323761c`
BLAKE2b-256 checksum How to use checksums	`a008771b899d6eab921fb688c114fb194c480cff214308840ac6809bf004209d`
Upload date	Oct 31, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.7`

Release files / stemflow-1.1.6-py3-none-any.whl

Download URL	stemflow-1.1.6-py3-none-any.whl
Size	95.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9595e59b8cda659b2efc7a719c4d21c019a623278bcab5218ec9ea94537a2646`
BLAKE2b-256 checksum How to use checksums	`19a76959d30a339a387c6c87e89df6028e0d59bf79d56c03eef13b4dca14bdbf`
Upload date	Oct 31, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.7`