Skip to content

Westlake-AI/UniWeat

Repository files navigation

UniWeat: Unified Toolbox for Weather Prediction

📘Documentation | 🛠️Installation | 🆕News

This repository is an open-source project for weather prediction (single and multiple variable prediction), which is built as an extensive project of OpenSTL. We are working on it and new features is updating!

News and Updates

[2023-04-27] UniWeat v0.1.0 is initalized (on updating).

Installation

This project has provided an environment setting file of conda, users can easily reproduce the environment by the following commands:

git clone https://github.com/Westlake-AI/UniWeat
cd UniWeat
conda env create -f environment.yml
conda activate UniWeat
python setup.py develop  # or `pip install -e .`
Dependencies
  • argparse
  • fvcore
  • numpy
  • hickle
  • scikit-image
  • scikit-learn
  • torch
  • timm
  • tqdm
  • xarray==0.19.0

Please refer to install.md for more detailed instructions.

Getting Started

Please see get_started.md for the basic usage. Here is an example of single GPU non-distributed training SimVP on Moving MNIST dataset.

bash tools/prepare_data/download_mmnist.sh
python tools/train.py -d mmnist --lr 1e-3 -c configs/mmnist/simvp/SimVP_gSTA.py --ex_name mmnist_simvp_gsta

(back to top)

Overview of Methods and Datasets

We support various spatiotemporal prediction learning (STL) methods and will provide benchmarks on various STL datasets.

(back to top)

License

This project is released under the Apache 2.0 license. See LICENSE for more information.

Acknowledgement

UniWeat is an open-source project for single and multiple variable weather prediction applications created by researchers in CAIRI AI Lab. We encourage researchers interested in weather prediction to contribute to UniWeat! UniWeat is an extensive project of OpenSTL.

Citation

If you are interested in our repository or our paper, please cite the following paper:

@misc{li2023uniweat,
  title={UniWeat: Unified Toolbox for Weather Prediction},
  author={Li, Siyuan and Lin, Haitao and Tan, Cheng and Chen, Lei and Li, Stan Z},
  howpublished = {\url{https://github.com/Westlake-AI/UniWeat}},
  year={2023}
}

Contribution and Contact

For adding new features, needing helps, or reporting bugs associated with UniWeat, please open a GitHub issue and pull request with the tag "new features", "help wanted", or "enhancement". Feel free to contact us through email if you have any questions. Enjoy!

(back to top)