Merge pull request #18 from actris-cloudnet/docs

Update docs
actris-cloudnet · Jun 26, 2024 · 693e0b1 · 693e0b1
2 parents 700ee24 + c7175a1
commit 693e0b1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/docs/source/fileformat.rst b/docs/source/fileformat.rst
@@ -5,7 +5,7 @@ All MWRpy files use ``NETCDF4_CLASSIC`` data model, i.e., ``HDF5`` file format.
 
 
 MWR-1C01 file
-............
+.............
 
 **Dimensions**
 

diff --git a/docs/source/mwrpy_processing.rst b/docs/source/mwrpy_processing.rst
@@ -121,7 +121,8 @@ Variables such as temperature profiles can be plotted from the newly generated f
 Command line usage
 ~~~~~~~~~~~~~~~~~~
 
-MWRpy can also be run using the command line tool `mwrpy/cli.py`:
+After defining the instrument type and site specific configuration files (including input/output data paths) in
+``mwrpy/site_config/``, MWRpy can also be run using the command line tool `mwrpy/cli.py`:
 
 .. code-block::
 

diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -5,15 +5,14 @@ Overview
 Summary
 -------
 
-`MWRpy`_ is a Python package to process microwave radiometer (MWR) data and was developed in the framework of `ACTRIS`_
-(Aerosol, Clouds and Trace Gases Research Infrastructure, `Laj 2024`_). MWRs are suited to gain information on
-the vertical
-structure of the atmosphere, especially in the lower troposphere, and profiles of temperature and humidity are
-retrieved together with integrated quantities of water vapor and the cloud liquid water path (LWP). The code is an
-advancement of the IDL based processing software `mwr_pro`_ and is able to handle raw data from instruments of the
-manufacturer Radiometer Physics GmbH (RPG, https://www.radiometer-physics.de/). The output format, including metadata
-information, variable names, and file naming of is designed to be compliant with the data structure and naming
-convention developed together with the EUMETNET Profiling Programme E-PROFILE (`Rüfenacht 2021`_).
+`MWRpy`_ (`Marke 2024`_) is a Python package to process microwave radiometer (MWR) data and was developed in the
+framework of `ACTRIS`_ (Aerosol, Clouds and Trace Gases Research Infrastructure, `Laj 2024`_). MWRs are suited to
+gain information on the vertical structure of the atmosphere, especially in the lower troposphere, and profiles of
+temperature and humidity are retrieved together with integrated quantities of water vapor and the cloud liquid water
+path (LWP). The code is an advancement of the IDL based processing software `mwr_pro`_ and is able to handle raw data
+from instruments of the manufacturer Radiometer Physics GmbH (RPG, https://www.radiometer-physics.de/). The output
+format, including metadata information, variable names, and file naming of is designed to be compliant with the data
+structure and naming convention developed together with the EUMETNET Profiling Programme E-PROFILE (`Rüfenacht 2021`_).
 
 One of the key components within the ACTRIS center for cloud remote sensing (CCRES) is the synergistic algorithm
 Cloudnet (`Illingworth 2007`_), which classifies hydrometeors in the atmosphere by combining several ground-based remote
@@ -39,6 +38,7 @@ Furthermore, generating comparable long-term datasets enables the analysis of tr
 sites in the network, which is expected to be beneficial not only for atmospheric studies, but also for improving
 knowledge on MWR operation and maintenance by additionally monitoring key instrument parameters.
 
+.. _Marke 2024: https://doi.org/10.21105/joss.06733
 .. _Laj 2024: https://doi.org/10.1175/BAMS-D-23-0064.1
 .. _Tukiainen 2020: https://doi.org/10.21105/joss.02123
 .. _Illingworth 2007: https://journals.ametsoc.org/doi/abs/10.1175/BAMS-88-6-883