The Pencil Code

Getting Started Quickly

Ultra Quick Start Guide
Quick Start Guide
Full User Manual

Community & Resources

Useful links
Discussion groups
Scientific usage
Python postrocessing meetings

Developing Pencil Code

Download the code
Git guide
svn guide
General commit guideline
Coding style
Social rules

Working with Simulations / Extra Tools

CVS guide
Super short Docker reference

Postprocessing & Tutorials

The Pencil Code: samples
Pencil Python Tutorials
IDL to Python Translation Guide for Pencil Code
Pencil Mathematica Tutorials
Python Package Development

Contributing to Documentation

Using Sphinx
Using reStructuredText
Tips for writing code documentation
How to generate autodocumentation for Fortran
How to add scientific citations to the PENCIL CODE

Autogenerated Documentation

Python packages
- conf
- setup
- stubs
  - Submodules
    - stubs.proboscis
- pencil
- pencil_ccyang
Fortran modules
Startup and run-time parameters
bin scripts

The Pencil Code

API Reference
stubs
View page source

stubs

Submodules

stubs.proboscis

Previous Next

© Copyright 2025, Illa R. Losada.

Built with Sphinx using a theme provided by Read the Docs.