Setting up the Pencil Code

• First, download with SVN the latest version of the code available at http://code.google.com/p/pencil-code/

  svn checkout http://pencil-code.googlecode.com/svn/trunk/ pencil-code
  

  You would normally do this from your $HOME directory. Note: if you do have a password for pencil-code.googlecode.com, check out the code from the https site (instead of the http one):

  svn checkout https://pencil-code.googlecode.com/svn/trunk/ pencil-code --username AxelBrandenburg
  

  where you replace AxelBrandenburg by your gmail name, and the password is the one generated by pencil-code.googlecode.com (→profile →settings).

• Under the tcsh shell, put in your $HOME/.cshrc file the following lines:

  #
  #  path for pencil code
  #
  if (! $?PENCIL_HOME) setenv PENCIL_HOME $HOME/pencil-code
  if (-r $PENCIL_HOME/sourceme.csh) then
    set _sourceme_quiet; source $PENCIL_HOME/sourceme.csh; unset _sourceme_quiet
  endif
  

  Note: If you want to change your default $SHELL to tcsh, type

    chsh
    /bin/tcsh
  

  The first command prompts you for your normal unix password.

• If you are under the bash shell, put in your $HOME/.bashrc file the following lines:

  #
  #  path for pencil code
  #
  if [ -z $PENCIL_HOME ]; then  export PENCIL_HOME=$HOME/pencil-code; fi
  if [ -e $PENCIL_HOME/sourceme.sh ]; then
    set _sourceme_quiet; source $PENCIL_HOME/sourceme.sh; unset _sourceme_quiet
  fi
  

• Also add the following useful alias:
  
  With tcsh: alias pc 'cd $PENCIL_HOME'
  With bash: alias pc='cd $PENCIL_HOME'
  
  such that you will directly move to the Pencil Code directory wherever you are by typing 'pc'.

• Source your updated $HOME/.cshrc or $HOME/.bashrc file by typing:
  
  With tcsh: source .cshrc
  With bash: source .bashrc
  
  
• Now you are ready for doing your first PC run (comments are given in the second column):
  
  

  pc	move to the PC directory
  cd samples/conv-slab	move to the sample 'conv-slab' which is in a 'samples' directory
  pc_setupsrc	initialize the local 'src' directory, copy necessary files, etc...
  make	compile the code
  mkdir data	create the data directory where all the outputs will be written
  start.csh	compute the initial setup at time t=0
  run.csh	launch the main code that advances the equations in time

  
  
  

If your disk quota is full, please do the following:

1) log in under a Failsafe session.

2) move the pencil-code directory to the local /scratch disk by typing:

mv pencil-code /scratch

3) then add in your home directory a symbolic link pointing to the new location:

ln -s /scratch/pencil-code .