Contents Menu Expand Light mode Dark mode Auto light/dark mode
snek5000
Logo
snek5000

Getting Started

  • Introduction
  • Installation
    • Installing ParaView package
  • Tutorials
    • First step with snek5000-phill: setting up a simulation
    • Second step with snek5000-phill: Snakemake rules
    • Demo periodic hill (snek5000-phill solver): running a simulation from a script
    • Demo Taylor-Green vortex (snek5000-tgv solver)
    • Demo sidewall convection (snek5000-cbox solver)
    • Configuring compilation and execution
    • Create your own Snek5000 solver, packaging your Nek5000 user source code
  • How-to guides
    • How to configure C and Fortran compilers
    • How to execute Snakemake commands from a directory
    • How to run a simulation in the foreground / background
    • How to restart simulations
    • How to load and represent data saved in state and stat files
    • How to parse, load and plot information contained in the Nek5000 log
    • How to load and plot history points
    • How to rebuild Nek5000 libraries and tools
    • How to export a standalone source code archive which excludes Snek5000
    • How to make a compressed archive of simulation data
    • How to Jinja templates
    • How to set adaptive time step in Nek5000
    • How to control Fortran warnings during compilation
    • How to read / write default parameter values from a *.par file

User guide & Python API

  • snek5000
    • snek5000.resources
    • snek5000.output
      • snek5000.output.base
      • snek5000.output.history_points
      • snek5000.output.print_stdout
      • snek5000.output.phys_fields
      • snek5000.output.spatial_means
      • snek5000.output.remaining_clock_time
    • snek5000.solvers
      • snek5000.solvers.base
      • snek5000.solvers.kth
    • snek5000.util
      • snek5000.util.archive
      • snek5000.util.console
      • snek5000.util.files
      • snek5000.util.restart
      • snek5000.util.smake
    • snek5000.clusters
    • snek5000.const
    • snek5000.info
    • snek5000.log
    • snek5000.magic
    • snek5000.make
    • snek5000.operators
    • snek5000.params
    • snek5000.config

Help & Reference

  • Developer Guide
    • Internal API of Simul
    • Internal API of InfoSolver
    • Internal API of Output
    • Internal API of Parameters
    • Internal API of PhysFields
      • snek5000.output.readers
        • snek5000.output.readers.pymech_
    • Notes on Nek5000 internals
    • Roadmap
    • How to run the tests
    • How to build the documentation
    • How to work on tutorials
    • Goodies
    • How to release
  • Contributing
  • Changelog
  • Authors
  • License
  • Source code on GitHub
Back to top

Authors#

  • Ashwin Vishnu Mohanan

  • Pierre Augier

  • Arman Khoubani

Next
License
Previous
Changelog
Copyright © 2019 - 2025, Ashwin Vishnu Mohanan. Published: 2025-05-07
Made with Sphinx and @pradyunsg's Furo