This software simulates SKIM sea surface current observations that can be applied to an ocean general circulation model (OGCM).

The code runs with python and uses the following libraries:

• Numpy

• Scipy

• NetCDF4 if you need to read netcdf4 model files (not included in Canopy)

If you don't have python and the needed python libraries on your machine you can download the enthought python distribution canopy at https://store.enthought.com/ and follow the installation instructions.

To install skimulator:

With pip in a python environnment:

-> Create your new environnement:

..code-block:: python > python -m venv [myenv]

-> Download the skimulator

..code-block:: python > git clone https://github.com/oceandatalab/skimulator.git

-> Install the skimulator

..code-block:: python > source [myenv] > pip install [pathtotheskimulator]

With conda:

..code-block:: python > conda install -c conda-forge swot_simulator

Reference orbits data are available online:

.. code-block:: console

$ cd [yourpath]/skimulator/data $ wget "https://oceandatalab.com/files/skim/orbits.tar.xz" $ tar xJf orbits.tar.xz

Rain statistical rain flags are available on the ftp for the Gulf Stream Region and the Equator:

.. code-block:: console

$ cd [yourpath]/skimulator/data $ wget "https://oceandatalab.com/files/skim/rain.tar.xz" $ tar xJf rain.tar.xz

Run the SKIM simulator:

For l2b products:

.. code-block:: python

skimul2b [your params file]

For l2c products:

.. code-block:: python

skimul2c [your params file]

For l2d products:

.. code-block:: python

skimul2d [your params file]

• To build the documentation, in the doc directory:

  • Build html: make html

  • Build pdf: make latexpdf

  The build documentation files are located in doc/build/html and in doc/build/latex/

• for a complete description: see the doc directory or just run pydoc PyDom

  .. doc: doc/html/index.html