The Pencil Code documentation

Welcome!

This is the new homepage of The Pencil Code documentation!

Explore the page hierarchy below (or in the sidebar), and get started with contributing your own documentation!

The Pencil Code is primarily designed to deal with weakly compressible turbulent flows, which is why we use high-order first and second derivatives. To achieve good parallelization, we use explicit (as opposed to compact) finite differences. Typical scientific targets include driven MHD turbulence in a periodic box, convection in a slab with non-periodic upper and lower boundaries, a convective star embedded in a fully nonperiodic box, accretion disc turbulence in the shearing sheet approximation, self-gravity, non-local radiation transfer, dust particle evolution with feedback on the gas, etc. A range of artificial viscosity and diffusion schemes can be invoked to deal with supersonic flows. For direct simulations regular viscosity and diffusion is being used.

Please find more details on our website.

Introduction

• Getting started
  • Using the documentation
  • Contributing to the documentation
• Using reStructuredText
  • About reST
  • Converting existing documents
  • Style guideline
• The Pencil Code links
• Discussion groups

User manuals

• Quick Guide
  • Required software
  • Download the Pencil Code
  • Configure the shell environment
  • Your first simulation run
  • Data post-processing

Tutorials

• Pencil Code Tutorials
  • Modifying the Pencil Code
  • Coding Style guide
  • Social Rules?
• Pencil Python Tutorials
  • Python Coding Style
  • Pencil Code Commands in General
  • Reading and Plotting Time Series
  • Reading and Plotting VAR files and slice files
  • Create a custom VAR0 or var.dat
  • Examples
  • IDL to Python guide
• Pencil Mathematica Tutorials
  • Loading the package
  • Pencil Code Commands in General
  • Reading and Plotting Time Series
  • Reading VAR files
  • Visualizing slices from VAR files
  • Reading video files
  • Running on supercomputers

Code documentation

• Pencil python code documentation
  • pencil: Pencil package
• IDL code documentation
• Fortran module
  • Module ascalar
  • Module Geometrical Types

---

Revision history

• Adding the github wiki content to readthedocs and a docstring example for python by Illa at 2021-09-21 02:11:21, 0ea2ac9

• added the tutorial page for mathematica package by Hongzhe Zhou at 2021-08-16 14:57:31, 33d91b3

• working on the documentation by Illa at 2021-08-12 23:45:44, 432ec0b

• Updating all the readthedocs documentation by Illa at 2021-08-09 20:45:37, 3901ba4

• adding readthedocs directory by Illa at 2021-05-26 02:16:24, 1c471b0