.. skplatform documentation master file, created by
   sphinx-quickstart on Tue Jan 15 12:30:27 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

###########
skplatform
###########
``skplatform`` is a package that represent platforms within the SK suite of retrieval and instrument modelling software.
The term *platform* is used to cover a broad range of hardware solutions wich are used to position and orient an atmospheric
remote-sensing instrument in space and time. This includes satellites, balloons, aircraft and ground-stations. The
package has been built so it can be used for both simulation studies and instrument data analysis.


***************
Getting Started
***************
This section will include details on getting started

********************
Installation Details
********************
``skplatform`` is a pure python package targeting python 3.6 and later.  The code is developed and tested on an Anaconda
distribution of Python 3.7. Pre-built wheels are available for installation.

.. toctree::
   :maxdepth: 2

   installation

********
Overview
********

.. toctree::
   :maxdepth: 2

   platforms_intro

****
API
****

.. toctree::
   :maxdepth: 2

   api_skplatform

*******************
Indices and tables
*******************

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`