a-profiles
Python library for reading and processing Lidar and ceilometer data
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.4%) to scientific vocabulary
Keywords
Repository
Python library for reading and processing Lidar and ceilometer data
Basic Info
- Host: GitHub
- Owner: AugustinMortier
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Homepage: https://augustinmortier.github.io/a-profiles/
- Size: 62.1 MB
Statistics
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 1
- Releases: 46
Topics
Metadata Files
README.md
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
clone this repository
git clone https://github.com/AugustinMortier/A-Profiles.gitinstallation
- 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://git@github.com/AugustinMortier/A-Profiles.git"
🚀 Get started
Reading Data
```python
import library
import aprofiles as apro
read local NetCDF L2 data
path = "examples/data/E-PROFILE/L20-20000-006735A20210908.nc" profiles = apro.reader.ReadProfiles(path).read() ```
Basic corrections and Image plotting
```python
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
```python
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
```python
image plotting with additional retrievals
profiles.plot(showfog=True, showclouds=True, show_pbl=True, vmin=1e-2, vmax=1e1, log=True)
```
Single Profile
```python
plot single profile at 21:20
datetime = np.datetime64('2021-09-09T21:20:00')
profiles.plot(datetime=datetime, vmin=-1, vmax=10, zmax=12000, showclouds=True, showpbl=True)
```
⚖️ License
🎓 Support
A-Profiles is developed by MET Norway and supported by EUMETNET.
Owner
- Name: augustinm
- Login: AugustinMortier
- Kind: user
- Location: Oslo, Norway
- Company: @metno
- Repositories: 1
- Profile: https://github.com/AugustinMortier
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: augustinm@met.no
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'
GitHub Events
Total
- Release event: 18
- Watch event: 3
- Delete event: 3
- Issue comment event: 4
- Push event: 91
- Pull request event: 10
- Create event: 20
Last Year
- Release event: 18
- Watch event: 3
- Delete event: 3
- Issue comment event: 4
- Push event: 91
- Pull request event: 10
- Create event: 20
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 3
- Total pull requests: 20
- Average time to close issues: over 2 years
- Average time to close pull requests: about 10 hours
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 1.67
- Average comments per pull request: 0.8
- Merged pull requests: 19
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 19
- Average time to close issues: N/A
- Average time to close pull requests: about 10 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.84
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- AugustinMortier (3)
Pull Request Authors
- AugustinMortier (29)
- charlienegri (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- 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
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite