API Reference

This page gives an overview of all public objects, functions, and methods available in the smash library. The core functionality of the API revolves around the primary smash.Model object, which serves as the central component for modeling and simulations.

Additionally, the following sub-packages provide access to essential tools and functionalities:

• smash.factory: Methods for creating essential elements, that are utilized by the Model object without requiring its prior instantiation.

• smash.io: Methods for handling input and output operations related to data objects.

• Model
  • Constructor
  • Attributes
  • Simulation
  • Parameters/States
• Simulation
  • Forward Run
  • Multiple Forward Run
  • Numerical Optimization
  • Multiple Numerical Optimization
  • Multiple Sets Estimation
  • Default Optimization Options
  • Optimization Control Vector Information
• Signal Analysis
  • Hydrograph Segmentation
  • Hydrological Signatures
  • Precipitation Indices
  • Evaluation Metrics

• Factory
  • Dataset Loading
  • Mesh Generation
  • Neural Network Configuration
  • Sample Generation
• Input/Output
  • Setup
  • Mesh
  • Model
  • Model Derived Data Types

• Returned Objects
  • Simulation
  • Signal Analysis

• Fortran
  • Derived Type
  • Methods