pencil-code

(β˜… 240)

A high-order finite-difference code for compressible hydrodynamic flows with magnetic fields and particles

File Explorer

Download Latest Version (.zip)

Showing a partial file list β€” download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • .gitmodules
  • .readthedocs.yaml
  • .travis.yml
  • fortran-parser
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/pencil-code/pencil-code

Downloads the entire project code from GitHub to your computer.

cd pencil-code

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f doc/readthedocs/documentation-docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r doc/readthedocs/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

βœ… If it runs without errors and prints output in the terminal, it worked.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd bugs/g95-fp-invalid

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

ChinaTextbook β˜… 79,814

ζ‰€ζœ‰ε°εˆι«˜γ€ε€§ε­¦PDF教材。

Roff
caveman β˜… 96,051

πŸͺ¨ why use many token when few token do trick β€” Claude Code skill that cuts 65% of tokens b

JavaScript
DeepSeek-R1 β˜… 92,027

No description provided.
ui-ux-pro-max-skill β˜… 119,179

An AI skill that provides design intelligence for building professional UI/UX across multi

Python
claude-mem β˜… 91,420

Persistent Context Across Sessions for Every Agent – Captures everything your agent does

JavaScript
d3 β˜… 113,510

Bring data to life with SVG, Canvas and HTML. :bar_chart::chart_with_upwards_trend::tada:

Shell
// repository documentation