Metadata-Version: 2.1
Name: pyLARDA
Version: 3.3.4
Summary: Data cube for handling atmospheric observations of profiling remote sensing instruments.
Home-page: https://github.com/lacros-tropos/larda
Author: pyLARDA-dev-team
Author-email: radenz@tropos.de
License: MIT License
Download-URL: https://github.com/lacros-tropos/larda/archive/refs/tags/v3.3.4.tar.gz
Description: 
        
        ## pyLARDA v3
        
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4721311.svg)](https://doi.org/10.5281/zenodo.4721311)
        [![PyPI version](https://badge.fury.io/py/pyLARDA.svg)](https://badge.fury.io/py/pyLARDA)
        
        
        pyLARDA for accessing and analysing ground based remote sensing data. 
        It tries to simplify following tasks:
        
        - finding netcdf files in a complex folder structure
        - loading data from differently formatted netcdfs
        - stitching data from consecutive files together
        - simplify common plotting tasks
        
        Documentation is available at [larda-doc](https://lacros-tropos.github.io/larda-doc/)
        
        ### Quick Setup (pypi)
        
        **requires** `python3.8`
        ```
        python3 -m venv larda-env
        source larda-env/bin/activate
        
        pip install setuptools -U
        pip install cython numpy==1.21
        pip install pyLARDA
        ```
        
        ### Requirements
        Currently pyLARDA is only targeted on unix operating system. 
        
        ```
        numpy==1.21
        scipy>=1.6
        netCDF4>=1.4.2
        msgpack
        cython>=0.29.13
        xarray
        matplotlib>=3.0.2
        requests>=2.21
        toml>=0.10.0
        tqdm>=4.36.1
        numba>=0.45.1
        # and for the documentation
        sphinx
        recommonmark
        sphinx_rtd_theme
        ```
        
        ### Setup (github)
        
        For development, local data sources and the backend, pyLARDA module can be installed with:
        ```
        python3 -m venv larda-env
        source larda-env/bin/activate
        pip3 install -r requirements.txt
        
        mkdir larda3
        cd larda3
        git clone https://github.com/lacros-tropos/larda.git
        
        python3 setup.py install
        ```
        
        Depending on your datasource of choice:
        
        #### remote
        You just need to know the link to the backend backend of choice and may move to Quickstart.
        
        #### local
        For local data it is necessary to include the source in a certain directory structure. For the setup of the config files consult the Guide to config-files.
        
        ```
        ├── larda        # github managed source code
        │   ├── docs
        │   ├── examples
        │   ├── ListCollector.py
        │   ├── pyLARDA  # actual python module
        │   ├── README.md
        │   ├── requirements.txt
        │   └── run_docs.sh
        ├── larda-cfg  # configuration files
        │   ├── campaigns.toml
        │   ├── [single campaign].toml
        │   └── [single campaign].toml
        ├── larda-connectordump
        │   └── [auto generated subfolder for each campaign]
        ├── larda-description
        │   ├── [...].rst
        └── larda-doc           # folder if you want to generate the docs
            └── ... 
        ```
        
        ### Quickstart
        Make sure that the module is available at your pythonpath when in doubt use `sys.path.append('dir')`.
        
        ```python
        import pyLARDA
        
        link_to_backend = 'http://...' 
        # or use pyLARDA.LARDA('local')
        larda = pyLARDA.LARDA('remote', uri=link_to_backend)
        print('available campaigns', larda.campaign_list)
        larda.connect('campaign_name')
        MIRA_Zg = larda.read("MIRA","Zg", [dt_begin, dt_end], [0, 4000])
        fig, ax = pyLARDA.Transformations.plot_timeheight2
            (MIRA_Zg, range_interval=[500, 3000], z_converter='lin2z')
        fig.savefig('MIRA_Z.png', dpi=250)
        ```
        
        For more examples refer to the scripts in the `examples` directory.
        
        
        ### Architecture
        
        ![overview on the structure](examples/api.png)
        
        
        ### Documentation
        An online version of the documentation is available at <https://lacros-tropos.github.io/larda-doc/>.
        For building simply run `.\run_docs.sh`, when the additinal libraries (`sphinx`, `recommonmark` and `sphinx_rtd_theme` are available; see above).
        
        ### History
        This version of the LACROS research data analyser (LARDA) is based on two prior versions in C and python2 respectively.
        Major changes are the migration to python3, netcdf4 and the inclusion of radar Doppler spectra.
        
        
        ### License
        Copyright 2022, pyLARDA-dev-team (Johannes Bühl, Martin Radenz, Willi Schimmel, Teresa Vogl, Moritz Lochmann, Johannes Röttenbacher)
        
        [MIT License](http://www.opensource.org/licenses/mit-license.php)
        For details see the LICENSE file.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
