Quickstart

Warning

PlatoSim is currently only available to memebers of the PLATO Mission Consortium (with a signed Non-Disclosure Agreement: NDA). Thus, to install (or download) the PlatoSim software, please contact one of the PlatoSim developers (see our GitHub page) for the credentials: <username> and <password>.

The easiest way to install PlatoSim is through our Conda installation using the following set of terminal commands to install the master branch:

conda create -n platosim python=3.10
conda activate platosim
conda install -c https://<username>:<password>@jenkins.miricle.org/platosim/ platosim

Create a working directory for which you want to store all your future PlatoSim projects (e.g. using platosim_workdir as our project folder and create a first project called quickstart):

mkdir -p $HOME/platosim_workdir/quickstart

Export the following paths (and add them to your bash file for future sessions):

export PLATO_PROJECT_HOME=$CONDA_PREFIX
export PLATO_WORKDIR=$HOME/plato_workdir
export PYTHONPATH=$PYTHONPATH:$PLATO_PROJECT_HOME/python

PlatoSim also requires a PSF file (which is not included in the default distribution because of its size), which you can download from our FTP site:

wget ftp://<username>:<password>@ftp.ster.kuleuven.be/PSF_Focus_0mu.hdf5 $PLATO_PROJECT_HOME/inputfiles

A simple test simulation from the command line looks like:

platosim $PLATO_PROJECT_HOME/inputfiles/inputfile.yaml $PLATO_WORKDIR/quickstart/test.hdf5

A simple test simulation from Python looks like:

import os
from platosim.simulation import Simulation
odir = os.getenv('PLATO_WORKDIR') + '/quickstart'
sim = Simulation('test', outputDir=odir)
sim.run()

We also recommend using Platonium, a user-friendly PlatoSim toolkit with lots of extra functionalities that help you create and run simulation projects very efficiently. Simply download this pyproject.toml file and follow Platonium’s prerequisites.