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

Docs: typo fixes and add AeroTools logo #1255

Merged
merged 4 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/aerotools_full_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/cli.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CLI
===

The CLI aims to be self-explanatory. Once pyaerocom is installed, and the command line you may run `pya --help` to see the full list of commands available.
The CLI aims to be self-explanatory. Once pyaerocom is installed, and the command line you may run `pya \-\-help` to see the full list of commands available.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,8 @@ def init_tutorials():
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_logo = "aerotools_full_logo.png"
html_theme_options = {
"logo_only": False,
"display_version": False,
}
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
***************************
pyaerocom
***************************
**A building block of AeroTools**

Official website of pyaerocom, a Python package for climate and air quality model evaluation.
Official website of pyaerocom, a Python package for climate and air quality model evaluation.

.. figure:: aerotools_workflow_202407.png

Expand Down
7 changes: 5 additions & 2 deletions docs/intro.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
About
============

pyaerocom is written and tested for python >= 3.10 and for-unix based systems. It provides tools for processing and analyzing data related to the the AeroTools model evaluation project at the Norwegian Meteorological institute, which services projects such as the `Copernicus Atmosphere Monitoring Service <https://atmosphere.copernicus.eu/>`_, `EMEP <https://www.emep.int/>`_, `NorESM <https://www.noresm.org/>`_, and `AeroCom <https://aerocom.met.no/>`_.
pyaerocom is written and tested for python >= 3.10 and for unix based systems. It provides tools for processing and analyzing data as part of the AeroTools model evaluation project at the `Norwegian Meteorological institute <https://www.met.no/>`_, which services projects such as the `Copernicus Atmosphere Monitoring Service <https://atmosphere.copernicus.eu/>`_, `EMEP <https://www.emep.int/>`_, `NorESM <https://www.noresm.org/>`_, and `AeroCom <https://aerocom.met.no/>`_.

The AeroTools project has the following mandate:

- Support for projects delivering model evaluation results
- User support for model-evaluation
- Database management of observation data
- Short and long-term development of evaluation tools, including web-pages showing evaluation results

The pyaerocom software is core part of the AeroTools project and therefore it's scope includes support for reading and processing of model data (e.g. AeroCom, EMEP, IFS), satellite data (e.g. TROPOMI, MODIS, AATSR) and ground based observation datasets (e.g. AERONET, EBAS, EARLINET, ICOS).
The pyaerocom software is a core part of the AeroTools project and therefore it's scope includes support for reading and processing of model data (e.g. AeroCom, EMEP, IFS), satellite data (e.g. TROPOMI, MODIS, AATSR) and ground based observation datasets (e.g. AERONET, EBAS, EARLINET, ICOS).
In addition, pyaerocom provides tools for colocation and cross evaluation of different datasets using commonly used statistics including several biases, gross-errors, and correlation coefficients.


Expand Down Expand Up @@ -70,3 +71,5 @@ Remark for Windows users
^^^^^^^^^^^^^^^^^^^^^^^^

pyaerocom is not tested on Windows systems and may only work in parts and thus some features may not work on Windows machines at the moment. Please let us know if you intend to use pyaerocom on a Windows machine so that we can consider adjusting our priorities, or also if you have any questions related to the usage.