Project Structure
The RTnn package is organized as follows:
rtnn/
├── src/rtnn/ # Main package
│ ├── __init__.py
│ ├── __main__.py
│ ├── version.py
│ ├── dataset.py # DataPreprocessor class
│ ├── evaluater.py # Metrics and loss functions
│ ├── diagnostics.py # Visualization tools
│ ├── logger.py # Rich logging
│ ├── main.py # Main training script
│ ├── model_loader.py # Model factory
│ ├── model_utils.py # Model utilities
│ ├── utils.py # File and general utilities
│ ├── stats.py # Statistical computations
│ └── models/ # Model architectures
│ ├── __init__.py
│ ├── rnn.py # LSTM and GRU
│ ├── fcn.py # Fully Connected Network
│ ├── Transformer.py # Transformer encoder
│ ├── UNet1D.py # 1D U-Net
│ └── DimChangeModule.py
├── tests/ # Unit tests
│ ├── test_rnn.py
│ ├── test_fcn.py
│ ├── test_transformer.py
│ ├── test_dataset.py
│ ├── test_evaluater.py
│ ├── test_model_loader.py
│ └── test_runner.py
├── docs/ # Documentation
│ ├── source/
│ └── build/
├── .github/workflows/ # CI/CD pipelines
│ ├── ci.yaml
│ └── docs.yml
├── pyproject.toml # Package configuration
├── README.rst # Project README
└── LICENSE # CC BY-NC-SA 4.0
Module Descriptions
Module |
Description |
|---|---|
|
DataPreprocessor for loading and preprocessing NetCDF files |
|
Loss functions and evaluation metrics |
|
Plotting and visualization utilities |
|
Rich console and file logging |
|
Main training pipeline entry point |
|
Factory function for model instantiation |
|
Model inspection and checkpoint management |
|
File utilities and EasyDict class |
|
Statistical computation for normalization |
|
Neural network architectures |