A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

A-Profiles

A python library dedicated to the analysis of atmospheric profilers measurements.
https://github.com/augustinmortier/a-profiles

Category: Atmosphere
Sub Category: Atmospheric Composition and Dynamics

Keywords

aerosol ceilometer lidar python

Last synced: about 23 hours ago
JSON representation

Repository metadata

Python library for reading and processing Lidar and ceilometer data

README.md

CI
Documentation Status
codecov

Python library for reading and processing ALC (Automated Lidars and Ceilometers) measurements. A-Profiles supports E-PROFILE ceilometer data. This library is used by V-Profiles.

📗 Documentation

The official documentation is available here.

✨ Installation

via pip

aprofiles is directly available on pip. This will install the latest released version of aprofiles and its depencencies.

  • with pip
pip install aprofiles
  • with pipx
pipx install aprofiles

from source

  1. clone this repository

    git clone https://github.com/AugustinMortier/A-Profiles.git
    
  2. installation

    • with pip (>21.3)

      pip install .
      
    • with pipx

      pipx install .
      
    • with poetry

      poetry install
      

In order to install directly the package from source with pip, you can also use the combined command

pip install "git+ssh://[email protected]/AugustinMortier/A-Profiles.git"

🚀 Get started

Reading Data

# import library
import aprofiles as apro

# read local NetCDF L2 data
path = "examples/data/E-PROFILE/L2_0-20000-006735_A20210908.nc"
profiles = apro.reader.ReadProfiles(path).read()

Basic corrections and Image plotting

# extrapolate lowest layers for removing outliers
profiles.extrapolate_below(z=150, inplace=True)

# image plotting of backscatter signal in log scale
profiles.plot(zref='agl', vmin=1e-2, vmax=1e1, log=True)

Profiles Analysis

# fog/condensation detection
profiles.foc(zmin_cloud=200) 

# clouds detection
profiles.clouds()

# planetary boundary layer
profiles.pbl(zmin=200, zmax=3000, under_clouds=True)

Visualization

Image

# image plotting with additional retrievals
profiles.plot(show_fog=True, show_clouds=True, show_pbl=True, vmin=1e-2, vmax=1e1, log=True)
Single Profile
# plot single profile at 21:20
datetime = np.datetime64('2021-09-09T21:20:00')
profiles.plot(datetime=datetime, vmin=-1, vmax=10, zmax=12000, show_clouds=True, show_pbl=True)

⚖️ License

GPL-3.0.

🎓 Support

A-Profiles is developed by MET Norway and supported by EUMETNET.

Citation (CITATION.cff)

cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
authors:
  - family-names: 'Mortier'
    given-names: 'Augustin'
    email: [email protected]
    affiliation: MET Norway
    orcid: 'https://orcid.org/0000-0002-7724-3583'
title: 'A-Profiles'
version: 0.7.0
doi: 10.5281/zenodo.7389683
date-released: 2022-12-02
url: 'https://github.com/AugustinMortier/A-Profiles'

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 869
Total Committers: 2
Avg Commits per committer: 434.5
Development Distribution Score (DDS): 0.001

Commits in past year: 201
Committers in past year: 1
Avg Commits per committer in past year: 201.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
augustinm a****m@m****o 868
charlien c****n@m****o 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 3
Total pull requests: 19
Average time to close issues: over 2 years
Average time to close pull requests: about 1 hour
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 1.67
Average comments per pull request: 0.74
Merged pull request: 19
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 18
Past year average time to close issues: N/A
Past year average time to close pull requests: about 1 hour
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.78
Past year merged pull request: 18
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/augustinmortier/a-profiles

Top Issue Authors

  • AugustinMortier (3)

Top Pull Request Authors

  • AugustinMortier (19)

Top Issue Labels

  • bug (1)
  • enhancement (1)

Top Pull Request Labels


Dependencies

pyproject.toml pypi
  • black ^22.3.0 develop
  • ipykernel ^6.5.1 develop
  • ipython ^8.0.1 develop
  • pytest ^6.2.5 develop
  • pytest-cov ^3.0.0 develop
  • dask ^2022.10.2
  • matplotlib ^3.5.0
  • miepython ^2.2.1
  • netCDF4 ^1.5.8
  • numpy ^1.21.4
  • orjson ^3.6.7
  • pydata-sphinx-theme >=0.9.0
  • python >=3.8,<3.11
  • recommonmark ^0.7.1
  • scipy ^1.7.2
  • seaborn ^0.11.2
  • sphinx ^4.3.0
  • tqdm ^4.62.3
  • typer ^0.7.0
  • xarray ^2022.03.0
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite

Score: 3.332204510175204