API

• pyshqg.preprocessing package
  • pyshqg.preprocessing.reference_data module
    • _data_file()
    • _open_zarr_data()
    • _add_padding()
    • load_reference_data()
    • interpolate_data()
    • load_test_data()
  • pyshqg.preprocessing.vertical_parametrisation module
    • VerticalParametrisation
      • VerticalParametrisation.rossby_radius_list
      • VerticalParametrisation.num_levels
      • VerticalParametrisation.__init__()
      • VerticalParametrisation.precompute_coupling_matrix()
  • pyshqg.preprocessing.orography module
    • Orography
      • Orography.land_sea_mask
      • Orography.orography
      • Orography.precorrect_planet_vorticity()
      • Orography.precompute_ekman_friction()
• pyshqg.core package
  • pyshqg.core.spectral_transformations module
    • SpectralTransformations
      • SpectralTransformations.backend
      • SpectralTransformations.T
      • SpectralTransformations.T_grid
      • SpectralTransformations.planet_radius
      • SpectralTransformations.planet_omega
      • SpectralTransformations.lats
      • SpectralTransformations.lons
      • SpectralTransformations.legendre
      • SpectralTransformations.laplacian_spectrum
      • SpectralTransformations.qp
      • SpectralTransformations.__init__()
      • SpectralTransformations.precompute_grid_nodes()
      • SpectralTransformations.precompute_legendre_coefficients()
      • SpectralTransformations.precompute_laplacian_spectrum()
      • SpectralTransformations.precompute_planet_vorticity()
      • SpectralTransformations.spec_to_grid_generic()
      • SpectralTransformations.spec_to_grid()
      • SpectralTransformations.spec_to_grid_grad_theta()
      • SpectralTransformations.spec_to_grid_grad_phi()
      • SpectralTransformations.grid_to_spec()
  • pyshqg.core.poisson module
    • QGPoissonSolver
      • QGPoissonSolver.backend
      • QGPoissonSolver.spectral_transformations
      • QGPoissonSolver.spec_qp
      • QGPoissonSolver.q_to_psi_coupling
      • QGPoissonSolver.__init__()
      • QGPoissonSolver.precompute_planet_vorticity()
      • QGPoissonSolver.precompute_q_to_psi_coupling()
      • QGPoissonSolver.q_to_total_q()
      • QGPoissonSolver.total_q_to_psi()
      • QGPoissonSolver.psi_to_zeta()
  • pyshqg.core.dissipation module
    • QGEkmanDissipation
      • QGEkmanDissipation.backend
      • QGEkmanDissipation.mu
      • QGEkmanDissipation.dmu_dphi
      • QGEkmanDissipation.dmu_dtheta
      • QGEkmanDissipation.__init__()
      • QGEkmanDissipation.compute_ekman_dissipation()
    • QGSelectiveDissipation
      • QGSelectiveDissipation.backend
      • QGSelectiveDissipation.spectrum
      • QGSelectiveDissipation.__init__()
      • QGSelectiveDissipation.compute_selective_dissipation()
    • QGThermalDissipation
      • QGThermalDissipation.backend
      • QGThermalDissipation.thermal_coupling
      • QGThermalDissipation.__init__()
      • QGThermalDissipation.compute_thermal_dissipation()
    • QGDissipation
      • QGDissipation.ekman
      • QGDissipation.selective
      • QGDissipation.thermal
  • pyshqg.core.source module
    • QGForcing
      • QGForcing.forcing
      • QGForcing.__init__()
      • QGForcing.compute_forcing()
  • pyshqg.core.model module
    • QGModelTrajectory
      • QGModelTrajectory.core_dimensions
      • QGModelTrajectory.model
      • QGModelTrajectory.time
      • QGModelTrajectory.variables
      • QGModelTrajectory.__init__()
      • QGModelTrajectory.append()
      • QGModelTrajectory.to_numpy()
      • QGModelTrajectory._num_batch_dimensions()
      • QGModelTrajectory.to_xarray()
    • QGModel
      • QGModel.backend
      • QGModel.spectral_transformations
      • QGModel.poisson_solver
      • QGModel.dissipation
      • QGModel.forcing
      • QGModel.model_state()
      • QGModel.model_trajectory()
      • QGModel.compute_dependent_variable()
      • QGModel.compute_dependent_variables()
      • QGModel.compute_model_tendencies()
      • QGModel.apply_euler_step()
  • pyshqg.core.integration module
    • RungeKuttaModelIntegrator
      • RungeKuttaModelIntegrator.model
      • RungeKuttaModelIntegrator.dt
      • RungeKuttaModelIntegrator.steps
      • RungeKuttaModelIntegrator.weights
      • RungeKuttaModelIntegrator.__init__()
      • RungeKuttaModelIntegrator.forward()
      • RungeKuttaModelIntegrator.run()
  • pyshqg.core.constructors module
    • construct_model()
    • construct_integrator()
• pyshqg.backend package
  • pyshqg.backend.abstract module
    • Backend
      • Backend.floatx
      • Backend.__init__()
      • Backend.from_numpy()
      • Backend.to_numpy()
      • Backend.expand_dims()
      • Backend.pad()
      • Backend.einsum()
      • Backend.range()
      • Backend.concatenate()
      • Backend.repeat()
      • Backend.apply_fft()
      • Backend.apply_ifft()
  • pyshqg.backend.numpy_backend module
    • NumpyBackend
      • NumpyBackend.from_numpy()
      • NumpyBackend.to_numpy()
      • NumpyBackend.expand_dims()
      • NumpyBackend.pad()
      • NumpyBackend.einsum()
      • NumpyBackend.range()
      • NumpyBackend.concatenate()
      • NumpyBackend.repeat()
      • NumpyBackend.apply_fft()
      • NumpyBackend.apply_ifft()
  • pyshqg.backend.tensorflow_backend module
    • TensorflowBackend
      • TensorflowBackend.from_numpy()
      • TensorflowBackend.to_numpy()
      • TensorflowBackend.expand_dims()
      • TensorflowBackend.pad()
      • TensorflowBackend.einsum()
      • TensorflowBackend.range()
      • TensorflowBackend.concatenate()
      • TensorflowBackend.repeat()
      • TensorflowBackend.apply_fft()
      • TensorflowBackend.apply_ifft()