SWAMPE’s documentation

SWAMPE is a 2D shallow-water general circulation model designed for simulating exoplanet atmospheres. SWAMPE is a fully in Python implementation of a spectral algorithm described in Hack and Jakob (1992) and previously available only in Fortran.

SWAMPE’s features currently include:

• Exoplanet atmosphere simulations that can be run on your laptop.

• Tuned for synchronously rotating hot Jupiters and sub-Neptunes.

• Can be easily adapted to model a variety of substellar objects.

This public release contains tutorials for running atmospheric simulations, working with SWAMPE output, and plotting.

SWAMPE is available under the BSD 3-Clause License.

Contributing

To report a bug or request a new feature, please open a new issue.

If you would like to get more actively involved in SWAMPE development, you are invited to get in touch ek672-at-cornell-dot-edu, and I will be happy to help you understand the codebase as you work on your contribution.

Tutorials:

• SWAMPE Quick Start
  • Running SWAMPE
  • Saving and loading SWAMPE data
• Plots
  • Plotting the geopotential plot with a wind vector field
  • Plotting mean-zonal winds
  • Plotting RMS winds during spinup
  • Creating gifs

Code Documentation:

• Continuation
  • compute_t_from_timestamp()
  • compute_timestamp()
  • load_data()
  • read_pickle()
  • save_data()
  • write_pickle()
• Filters
  • diffusion()
  • modal_splitting()
  • sigma()
  • sigma6()
  • sigma6Phi()
  • sigmaPhi()
• Forcing
  • Phieqfun()
  • Qfun()
  • Qfun_with_rampup()
  • Rfun()
• Initial conditions
  • ABCDE_init()
  • coriolismn()
  • spectral_params()
  • state_var_init()
  • test1_init()
  • velocity_init()
• Model
  • run_model()
• Plotting
  • fmt()
  • gif_helper()
  • mean_zonal_wind_plot()
  • quiver_geopot_plot()
  • spinup_plot()
  • write_quiver_gif()
• Spherical Harmonic Transforms
  • PmnHmn()
  • diagnostic_eta_delta()
  • fwd_fft_trunc()
  • fwd_leg()
  • invrsUV()
  • invrs_fft()
  • invrs_leg()
• Time stepping
  • RMS_winds()
  • mJarray()
  • marray()
  • narray()
  • tstepcoeff()
  • tstepcoeff2()
  • tstepcoeffmn()
  • tstepping()
• Modified Euler’s Method
  • delta_timestep()
  • eta_timestep()
  • phi_timestep()

Indices and tables

• Index

• Module Index

• Search Page