Skip to content

Commit bcda3d4

Browse files
authored
Merge pull request #198 from esowc/branch-alba
Update README.md
2 parents f05c6d3 + d09a312 commit bcda3d4

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Atmospheric Datasets Comparison (ADC) Toolbox is aimed to have a set of tools th
3636

3737
A full explanation of the initial version of this software and its theoretical background can be read in <a href = "https://www.researchgate.net/publication/359342884_Development_of_a_Toolbox_to_Compare_Atmospheric_Composition_Datasets_Long-term_trends_in_urban_NO2_concentrations_in_Spain_derived_from_CAMS_reanalysis_and_GOME-2_data" target = "_blank">Research Gate</a>.
3838

39-
Users can install the software in their desktop by following the steps described in <a href = "#requirements">Requirements</a>. A <a href = "https://nbviewer.org/github/esowc/adc-toolbox/blob/main/thesis/case_study.ipynb" target = "_blank">case study</a> was created to show the usability of the toolbox for deriving long-term trends in air pollution.
39+
Users can install the software in their desktop by following the steps described in <a href = "#requirements">Requirements</a>. A <a href = "https://nbviewer.org/github/esowc/ADC Toolbox/blob/main/thesis/case_study.ipynb" target = "_blank">case study</a> was created to show the usability of the toolbox for deriving long-term trends in air pollution.
4040

4141
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)
4242

@@ -50,7 +50,7 @@ ADC Toolbox facilitates the retrieval of all the datasets presented in Table 1,
5050
| Source | Type | Platform | NO<sub>2</sub> | O<sub>3</sub> | CO | SO<sub>2</sub> | HCHO |
5151
| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
5252
| CAMS | Forecast | <a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-atmospheric-composition-forecasts" target = "_blank">ADS</a> | 01.2015 - Present | 01.2015 - Present | 01.2015 - Present | 01.2015 - Present | 01.2015 - Present |
53-
| CAMS | Reanalysis | <a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-ghg-reanalysis-egg4-monthly">ADS</a> | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 |
53+
| CAMS | Reanalysis | <a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-ghg-reanalysis-egg4-monthly" target = "_blank">ADS</a> | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 | 01.2003 - 06.2021 |
5454
| TROPOMI | L2 | <a href = "https://s5phub.copernicus.eu/dhus/" target = "_blank">S5-P hub</a> | 07.2018 - Present | 07.2018 - Present | 07.2018 - Present | 10.2018 - Present | 07.2018 - Present |
5555
| TROPOMI | L3 | <a href = "https://www.temis.nl/" target = "_blank">TEMIS</a> | 07.2018 - Present | - | - | - | - |
5656
| IASI | L2 | <a href = "https://iasi.aeris-data.fr/" target = "_blank">AERIS Portal</a> | - | 01.2008 - Present | 10.2007 - Present | 10.2007 - Present | - |
@@ -72,14 +72,14 @@ The needed packages to run this software can be found in <em>requirements.txt</e
7272
```bash
7373
$ conda config --set channel_priority false
7474
$ conda env create -f environment.yml
75-
$ conda activate adc-toolbox
75+
$ conda activate ADC Toolbox
7676
```
7777

7878
If this takes too long, they can manually create it instead <strong>(recommended)</strong>:
7979

8080
```bash
81-
$ conda create --name adc-toolbox
82-
$ conda activate adc-toolbox
81+
$ conda create --name ADC Toolbox
82+
$ conda activate ADC Toolbox
8383
$ conda install -c conda-forge/label/cartopy_dev cartopy
8484
$ pip install -r requirements.txt
8585
```
@@ -103,7 +103,7 @@ Lately, there have been problems retrieving the data from NACIS Natural Earth to
103103

104104
<h3>3.3. Scatter plots by country</h3>
105105

106-
In case users want to see the distribution of the components by countries, they will need a Google API Key, Client User ID and Secret. The library Geocoder is used to get the data from Google, but it also allows the users of the ADC-Toolbox to use other APIs to do reverse geocoding (retrieving location information by coordinates). In the function scatter_plot, they will find the following line. You can rewrite as they wish. The list of providers can be found in <a href = "https://github.com/DenisCarriere/geocoder" target = "_blank"> <em>Geocoder</em>'s Github repository</a>.
106+
In case users want to see the distribution of the components by countries, they will need a Google API Key, Client User ID and Secret. The library Geocoder is used to get the data from Google, but it also allows the users of the ADC Toolbox to use other APIs to do reverse geocoding (retrieving location information by coordinates). In the function scatter_plot, they will find the following line. You can rewrite as they wish. The list of providers can be found in <a href = "https://github.com/DenisCarriere/geocoder" target = "_blank"> <em>Geocoder</em>'s Github repository</a>.
107107
```python
108108
>>> merge_df['Country'] = merge_df.apply(lambda row: geocoder.google([row['latitude'], row['longitude']],
109109
method = 'reverse', key = google_api_key).country_long,
@@ -162,7 +162,7 @@ If they do not want to edit anything and prefer to run the code using Google API
162162
<h3>5.1. Data sources</h3>
163163
<ul>
164164
<li><a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-atmospheric-composition-forecasts" target = "_blank">ADS: CAMS global atmospheric composition forecasts</a></li>
165-
<li><a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-ghg-reanalysis-egg4-monthly">ADS: CAMS global greenhouse gas reanalysis (EGG4) monthly averaged fields</a></li>
165+
<li><a href = "https://ads.atmosphere.copernicus.eu/cdsapp#!/dataset/cams-global-ghg-reanalysis-egg4-monthly" target = "_blank">ADS: CAMS global greenhouse gas reanalysis (EGG4) monthly averaged fields</a></li>
166166
<li><a href = "https://s5phub.copernicus.eu/dhus" target = "_blank">S5-P hub: TROPOMI datasets (L2)</a></li>
167167
<li><a href = "https://www.temis.nl/" target = "_blank">TEMIS: TROPOMI and GOME-2 datasets (L3)</a></li>
168168
<li><a href = "https://iasi.aeris-data.fr/" target = "_blank">AERIS Portal: IASI datasets (L2 and L3)</a></li>
@@ -181,7 +181,7 @@ If they do not want to edit anything and prefer to run the code using Google API
181181
<h3>5.3. Other useful references</h3>
182182
<ul>
183183
<li><a href = "https://gitlab.eumetsat.int/eumetlab/atmosphere/atmosphere/-/blob/master/functions.ipynb" target = "_blank">Supporting functions from LTPy training course</a></li>
184-
<li><a href = "https://confluence.ecmwf.int/display/OIFS/4.4+OpenIFS%3A+Vertical+Resolution+and+Configurations">CAMS model vertical resolution and configuration</a></li>
184+
<li><a href = "https://confluence.ecmwf.int/display/OIFS/4.4+OpenIFS%3A+Vertical+Resolution+and+Configurations" target = "_blank">CAMS model vertical resolution and configuration</a></li>
185185
</ul>
186186

187187
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)
@@ -197,6 +197,7 @@ If you are interested in the ADC toolbox and would like it to have other functio
197197
<h2 id = "author">7. Author</h2>
198198
<p align = "center"><img style = "border-radius: 50%;" src = "report/Alba_Vilanova_profile_image.jpg" alt = "Alba Vilanova Cortezón" width = 150px></img><br>
199199
<b>Alba Vilanova Cortezón</b><br>
200+
Research Engineer at <a href = "https://www.bsc.es/" target = "_blank">Barcelona Supercomputing Center</a><br>
200201
BEng in Mechanical Engineering at <a href ="https://www.udl.cat/ca/en/" target = "_blank">University of Lleida</a> and <a href ="http://eng.inha.ac.kr/" target = "_blank">Inha University</a><br>
201202
MSc in Geospatial Technologies at <a href ="https://www.novaims.unl.pt/default" target = "_blank">NOVA University of Lisbon</a>, <a href ="https://www.uni-muenster.de/en/" target = "_blank">WWU Münster</a> and <a href ="https://www.uji.es/" target = "_blank">UJI</a><br>
202203
GitHub: <a href="https://github.com/albavilanova" target = "_blank">@albavilanova</a><br>
@@ -208,6 +209,6 @@ Website: <a href = "https://albavilanova.es/" target = "_blank">https://albavila
208209

209210
<!-- SUPPORT -->
210211
<h2 id = "support">8. Support</h2>
211-
ADC-Toolbox has been developed under the framework set by <a href ="https://esowc.ecmwf.int/" target = "_blank">ECMWF Summer of Weather Code</a>:<br><br>
212+
ADC Toolbox has been developed under the framework set by <a href ="https://esowc.ecmwf.int/" target = "_blank">ECMWF Summer of Weather Code</a>:<br><br>
212213
<p align = "center"><img src = "report/ESoWC_logo.png" alt = "Logo of ESoWC" width = 300px></img></p>
213214
A special <b>thanks to my mentors Federico Fierli, Antje Inness and Miha Razinger</b> for their support and guidance.

0 commit comments

Comments
 (0)