doc.php

<!-- $Id$ -->
<?php
	 include "inc/header.inc";
 ?>
<div class="centcolumnpad">
<h2>Documentation</h2>
The manual for the Pencil Code is available <a href="https://github.com/pencil-code/website/raw/master/doc/manual.pdf" target="_blank">in PDF</a> (3.9M).

<p>
<b><u>Hint:</u></b> We also have a <a href="https://github.com/pencil-code/website/raw/master/doc/quick_start.pdf" target="_blank">Quick Start guide</a> for beginners.
</p>
</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Supplements</h2>
<p>
Axel Brandenburg gave a general presentation on the Pencil Code in Oslo (2003):
<i>The Pencil Code: multi-purpose and multi-user maintained.</i>
(<a href="http://pencil-code.nordita.org/~brandenb/talks/misc/pencil-code2003.htm">html</a>, <a href="http://pencil-code.nordita.org/~brandenb/talks/misc/pencil-code2003.ppt">PowerPoint</a>).
</p>

<p>
Wlad Lyra has written a <a href="/doc/hello_disk.pdf" target="_blank">tutorial</a> for setting up
global accretion disk simulations.
</p>

<p>
Wolfgang Dobler wrote
<a href="/doc/git-getting-started.pdf">Git Getting Started</a> (Jun 10, 2016) and
<a href="/doc/git-best-practises.pdf">Git Best Practises</a> guide (Jun 10, 2016).
</p>

<p>
Deepen Garg wrote
<a href="/doc/MacOS/Pencil_Code_MacOS_Writeup.pdf">Instructions for MacOS installation</a> (Sep 29, 2024),
and Mattia Cielo emphasized
<a href="/doc/MacOS/Cielo_23-Feb-2026.html">the need to cancel the Nvidia dependencies</a> on his Apple Silicon MacBook (Feb 23, 2026).
</p>

<p>
Responses to a problematic git check-in and how to avoid it by
<a href="https://pencil-code.nordita.org/~brandenb/pencil-code/presentations/typical_mistakes/Hongzhe_response_August2022.html">Hongzhe Zhou (August 24, 2022)</a>,
<a href="https://pencil-code.nordita.org/~brandenb/pencil-code/presentations/typical_mistakes/Philippe_response_November2022.html">Philippe Bourdin (November 4, 2022</a> and
<a href="https://pencil-code.nordita.org/~brandenb/pencil-code/presentations/typical_mistakes/Philippe_response_December2022.html">December 4, 2022)</a>:
<a href="https://pencil-code.nordita.org/~brandenb/pencil-code/presentations/typical_mistakes/Philippe_response_December2022b.html">How to commit without "Master Branch Merge"?</a>.
</p>

<p>
Matthias Rheinhardt presented a talk about the
<a href="/UserMeetings/2016/talks/YinYang_talk.pdf">Yin-Yang mesh</a> (10 Aug 2016)
and the GPU acceleration in the Pencil Code using Astaroth:
<a href="http://pencil-code.nordita.org/doc/GPUs/Presentation3.pdf">Introduction to PC-A</a> 
[<a href="http://pencil-code.nordita.org/doc/GPUs/Presentation3.pptx">pptx</a>] (25 Sep 2024) 
</p>

<p>
A Python introduction can be found here:
<a href="http://github.com/pencil-code/pencil-code/wiki/PythonForPencil">Python with the Pencil Code</a>; see also the
<a href="https://pencil-code.readthedocs.io/en/latest/tutorials/python/tutpython.html">Pencil Python Tutorials</a>.
</p>

<p>
In her teaching material from the Barcelona User Meeting, Jennifer Schober explains
<a href="https://jennifer-schober.com/teaching/pcum2024/">How to simulate turbulent dynamos with the Pencil Code</a> (Sep 25, 2024).
</p>

<p>
<a href="https://github.com/pencil-code/website/blob/master/doc/citations.pdf">Scientific usage of the Pencil Code</a>.
</p>


</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Tests and timings</h2>
For information how to do benchmark tests and timings, see the <a href="/timings.php">benchmark page</a>.
</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Teaching</h2>
The code has been used
for teaching on a number of occasions. Some online material with
exercises is available through the
<a href="http://pencil-code.nordita.org/~brandenb/teach/PencilCode/">Numerical Experiments</a> page.

</div>
<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>FAQ</h2>
For code problems, please check this automatically generated <a href="/doc/faq.php">excerpt from the manual with FAQs</a>.
</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Wiki</h2>
Some helpful information are available on our <a href="http://github.com/pencil-code/pencil-code/wiki">project wiki</a>.
</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Read the Docs</h2>
Some helpful information are available on our <a href="https://pencil-code.readthedocs.io/en/latest/">Read the Docs</a>.
</div>

<div class="centerdivider"></div>
<div class="centcolumnpad">
<h2>Newsletter</h2>
Since July 2020, the Pencil Code community has a newsletter to inform the users about recent developments,
events, and opportunities.
Back issues are available <a href="https://github.com/pencil-code/website/tree/master/NewsLetters">here</a>.
</div>

<?php
	include "inc/footer.inc";
 ?>