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 <https://github.com/IvS-KULeuven/PlatoSim3>`_ for the credentials (**username** and **password**).


- All information needed to install and update PlatoSim is described in the sections: :doc:`Installation <install_overview>` and :doc:`Running PlatoSim <run_overview>`. Please, follow these instructions carefully before running PlatoSim.
- The PlatoSim software package includes a Python interface (with a suite of tools) which we explain in our `Python tutorials <https://github.com/IvS-KULeuven/PlatoSim3/tree/master/docs/tutorials>`_. We highly recommend to use this interface to avoid sudden software errors when updating your code (since our Python interface is kept backward compatible with previous software versions).
- Particularly relevant for simulating multi-camera imagette time series or light curves, the PlatoSim toolkit called :doc:`PLATOnium <platonium_overview>` may be of interest.
- In case of questions or problems, see our :doc:`Troubleshooting <basic_troubleshooting>` section.
- For more information about the building blocks of PlatoSim, consult the :doc:`Architecture <basic_architecture>` section and the :doc:`PlatoSim3 paper <basic_acknowledgements>`.