Skip to main content

A personal reimplementation of NowcastNet inference framework

Project description

NowcastNet-Rewritten

1. Introduction

This project is a personal reimplementation of the NowcastNet inference framework. The original research, titled "Skilful nowcasting of extreme precipitation with NowcastNet," by Yuchen Zhang, Mingsheng Long et al., was published in Nature and can be accessed at https://www.nature.com/articles/s41586-023-06184-4. Additionally, the original code by Yuchen Zhang is available at https://doi.org/10.24433/CO.0832447.v1.

Q: Why reimplement? A: Just for learning :)

2. Getting Started

  1. Cloning the repository:

    git clone https://github.com/VioletsOleander/nowcastnet-rewritten.git
    
  2. Install the dependencies (pick one of the following methods):

    • Sync dependencies using uv:

      uv sync
      
    • Make sure python>=3.10,<3.11, and either install from PyPI:

      pip install -U nowcastnet-rewritten
      

      or install from local:

      pip install .
      

Notes:

  • uv is recommended for managing dependencies for full reproducibility.
  • To ensure compatibility with this reimplementation's architecture, weights have been modified and are available for download from Hugging Face.

3. Usage

To perform inference, run inference.py with the required arguments.

To view all available arguments, use:

python inference.py -h

It is recommended to use the --config_path option to specify the configuration file, for example:

python inference.py --config_path ../configs/inference.toml

An example configuration file is provided in the configs/ directory.

You can also specify options directly from the command line, for example:

python inference.py \
    --case_type normal \
    --device cuda:0 \
    path_to_weights \
    path_to_data \
    path_to_result

Note: If --config_path is specified, other command line options will be ignored.

4. Example Inference Result

1024 x 1024:

Inference output at 1024×1024 resolution

512 x 512:

Inference output at 512x512 resolution

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nowcastnet_rewritten-0.1.1.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nowcastnet_rewritten-0.1.1-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file nowcastnet_rewritten-0.1.1.tar.gz.

File metadata

File hashes

Hashes for nowcastnet_rewritten-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d6dd313d7d556d9f6870ac06bb2675cc3e001c4fe54ff465212901e77c2dde4a
MD5 2f7037dbee6ca3c7573265665a993fac
BLAKE2b-256 4110ddd8ba7b6ff3244c4c0f5ab5e075bdd8ab813f021aee227fa421df4902e1

See more details on using hashes here.

File details

Details for the file nowcastnet_rewritten-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for nowcastnet_rewritten-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5edabacaac9106a5238781f9b2c5ea0fff6fe15c4a9baee8f7e7724aadb0d5c2
MD5 f47f2b20e46b2d55651b84f804f81809
BLAKE2b-256 ae35814426f92d590e40c031b381994536837f33099d865873cfbb4cdf7b1ac4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page