Skip to content
Snippets Groups Projects
Commit 274f9efe authored by Anne Philipp's avatar Anne Philipp
Browse files

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

parent 708c6674
Branches
Tags
No related merge requests found
Showing
with 125 additions and 14 deletions
History of Changes
==================
UNDER CONSTRUCTION
\ No newline at end of file
Download tar-balls
==================
UNDER CONSTRUCTION
\ No newline at end of file
......@@ -3,8 +3,19 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to flex_extract's documentation!
========================================
Welcome to flex_extract's user documentation!
=============================================
flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system.
.. The scripts can be 1) executed locally using the ECMWF WebMARS interface, or 2) on the ECMWF member
.. state gateway server or HPC facility using the ecaccess software package. As another option the scripts can 3)
.. also be triggered using ecflow scheduling software used by ECMWF for data dissemination.
All required second party software and libraries used within flex_extract is open source and free of charge.
.. raw:: html
<table style="width:100%;">
......@@ -86,7 +97,7 @@ Welcome to flex_extract's documentation!
License text put in here! Which one?
.. toctree::
:maxdepth: 2
:maxdepth: 3
:caption: Table of Contents:
downloads
......
Installation
============
Describe installation process flex_extract ....
UNDER CONSTRUCTION
\ No newline at end of file
UNDER CONSTRUCTION
.. toctree::
:hidden:
:maxdepth: 2
installation/requirements
installation/oper_modes
installation/test_install
\ No newline at end of file
Operating modes
===============
UNDER CONSTRUCTION
\ No newline at end of file
Requirements
============
UNDER CONSTRUCTION
Installation test
=================
UNDER CONSTRUCTION
\ No newline at end of file
Operating modes
===============
UNDER CONSTRUCTION
\ No newline at end of file
......@@ -3,4 +3,12 @@ Program Structure
Describe structure of flex_extract ....
UNDER CONSTRUCTION
\ No newline at end of file
UNDER CONSTRUCTION
.. toctree::
:hidden:
:maxdepth: 2
program_structure/prog_overview
program_structure/prog_components
program_structure/prog_flow
Program Components
==================
UNDER CONSTRUCTION
\ No newline at end of file
Program Flow
================
UNDER CONSTRUCTION
\ No newline at end of file
Program Overview
================
UNDER CONSTRUCTION
\ No newline at end of file
Requirements
============
Describe the requirements to use flex_extract ....
UNDER CONSTRUCTION
\ No newline at end of file
UNDER CONSTRUCTION
Support
=======
Describe support options ....
UNDER CONSTRUCTION
\ No newline at end of file
UNDER CONSTRUCTION
.. toctree::
:hidden:
:maxdepth: 2
support/ticket_system
support/mailing_list
support/known_bugs_issues
support/faq
\ No newline at end of file
FAQ - Frequently asked questions
================================
UNDER CONSTRUCTION
\ No newline at end of file
Known Bugs and Issues
=====================
UNDER CONSTRUCTION
\ No newline at end of file
Mailing Lists
=============
UNDER CONSTRUCTION
\ No newline at end of file
Ticket System
=============
UNDER CONSTRUCTION
\ No newline at end of file
Installation test
=================
UNDER CONSTRUCTION
\ No newline at end of file
User Guide
==========
Describe using flex_extract ....
UNDER CONSTRUCTION
\ No newline at end of file
UNDER CONSTRUCTION
.. toctree::
:hidden:
:maxdepth: 2
user_guide/how_to
user_guide/control_templates
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment