The Pencil Code Logo

Getting Started Quickly

  • Ultra Quick Start Guide
  • Quick Start Guide
  • Full User Manual
    • 1. Preamble
    • 2. Part 1: Using the PENCIL CODE
    • 3. Part 2: Programming the PENCIL CODE
    • 4. Appendix

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
  • Fortran modules
  • Startup and run-time parameters
  • bin scripts
The Pencil Code
  • The Pencil Code: A High-Order MPI code for MHD Turbulence
  • View page source

The Pencil Code: A High-Order MPI code for MHD Turbulence

Contents

  • 1. Preamble
    • 1.1. Contributors list and GitHub stats
    • 1.2. Contributors to the code:
    • 1.3. Copyright and License
    • 1.4. Foreword
    • 1.5. Acknowledgments
  • 2. Part 1: Using the PENCIL CODE
    • 2.1. System requirements
    • 2.2. Obtaining the code
    • 2.3. Getting started
    • 2.4. Code structure
    • 2.5. Using the code
    • 2.6. The equations
    • 2.7. Troubleshooting / Frequently Asked Questions
    • 2.8. References
  • 3. Part 2: Programming the PENCIL CODE
    • 3.1. Understanding the code
    • 3.2. Adapting the code
    • 3.3. Testing the code
    • 3.4. Useful internals
    • 3.5. References
  • 4. Appendix
    • 4.1. Appendix A: Timings
    • 4.2. Appendix B: Coding standard
Previous Next

© Copyright 2025, Illa R. Losada.

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