Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AeroVal config documentation example #495

Merged
merged 14 commits into from
Oct 18, 2021
Merged

Add AeroVal config documentation example #495

merged 14 commits into from
Oct 18, 2021

Conversation

jgliss
Copy link
Contributor

@jgliss jgliss commented Oct 15, 2021

This PR adds an AeroVal example configuration script in the ReadTheDocs page, that explains the main setup and options.

It also fixes a few issues that were detected after release of v0.12.1 when trying to run the example setup, e.g. #494.

@jgliss jgliss self-assigned this Oct 15, 2021
@jgliss jgliss added the documentation 📖 Everything related to code documentation, tutorials and examples label Oct 15, 2021
@jgliss jgliss added this to the v0.12.2 milestone Oct 15, 2021
@jgliss jgliss linked an issue Oct 15, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Oct 15, 2021

Codecov Report

Merging #495 (851abb2) into main-dev (b3d15ac) will increase coverage by 0.03%.
The diff coverage is 71.42%.

Impacted file tree graph

@@             Coverage Diff              @@
##           main-dev     #495      +/-   ##
============================================
+ Coverage     76.61%   76.64%   +0.03%     
============================================
  Files            97       97              
  Lines         17358    17357       -1     
============================================
+ Hits          13299    13304       +5     
+ Misses         4059     4053       -6     
Flag Coverage Δ
unittests 76.64% <71.42%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pyaerocom/aeroval/setupclasses.py 93.14% <ø> (ø)
pyaerocom/io/read_aeronet_invv3.py 34.04% <ø> (ø)
pyaerocom/io/read_aeronet_sdav3.py 92.78% <ø> (-0.08%) ⬇️
pyaerocom/io/readgridded.py 72.54% <ø> (ø)
pyaerocom/io/readaeronetbase.py 65.48% <52.94%> (+1.73%) ⬆️
pyaerocom/aeroval/coldatatojson_engine.py 85.29% <100.00%> (ø)
pyaerocom/colocation_auto.py 82.50% <100.00%> (+0.02%) ⬆️
pyaerocom/exceptions.py 100.00% <100.00%> (ø)
pyaerocom/io/read_aeronet_sunv3.py 91.07% <100.00%> (ø)
pyaerocom/stationdata.py 81.51% <100.00%> (ø)
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3d15ac...851abb2. Read the comment docs.

@jgliss
Copy link
Contributor Author

jgliss commented Oct 15, 2021

@dulte and @jgriesfeller and @AugustinMortier please be aware of the changes here, I found some bugs and inconsistencies in the variable handling for the output files when creating the example config. The problem is that pyaerocom was using the AeroCom variable name for the output files and not the input variable name, which resulted in AeroVal not displaying "ang4487csaer" from NorESM2 in the model maps plots, because "ang4487csaer" is an alias for "ang4487aer".

I think this affects only cases where alias variables are used, and it is good that this was detected now, since this variable mappings is always a mess.

Copy link
Collaborator

@dulte dulte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good :) Wonderful documentation of the config. I will use it to document a more advanced example :)

@jgliss jgliss merged commit 25aea64 into main-dev Oct 18, 2021
@jgliss jgliss deleted the add-aeroval-docs branch October 18, 2021 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Everything related to code documentation, tutorials and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AERONET reading broken after bug fix in release v0.12.0
2 participants