Commit 4cf7d6e8 authored by Clara Betancourt's avatar Clara Betancourt
Browse files

update license and readme

parent c33cf5a9
Copyright 2020 Clara Betancourt
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
......@@ -12,9 +12,8 @@ This project consists of two parts:
These instructions will get you a copy of the project up and running on ZAM347.
* Run the preparation script ```source prepare.sh``` to create data directories for this project. It will also create and activate the virtual environment.
* Turn on FZJ VPN for TOAR access.
* Create a file ```settings.py``` in the source directory which contains your credentials for TOAR-DB:
* If would like to download the AQ-Bench data set, turn on FZJ VPN for TOAR access.
* Create a file ```settings.py``` in the source directory which contains your credentials for TOAR-DB (if you do not have access to TOAR-db, then just leave '***' for username and password):
```
db_user = '****'
......@@ -23,17 +22,41 @@ db_host = 'zam10131.zam.kfa-juelich.de'
db_port = '5432'
db_name = 'surface_observations_toar'
```
## Obtain AQbench dataset
* Run ```./run.sh```
## Resources
The resources folder contains .csv files with necessary info to handle the data set.
* ```AQbench_variables.csv```: Info on all variables in the data set
* ```*_cols.csv```: Info for data set retrieval
* ```climatic_zone.csv```, ```htab_region.csv```, ```climatic_landcover.csv```: Info on decoded variables
## Run Scripts
Run ```./run.sh``` to start the interactive script starter. You may choose from various options:
* ```prepare ```
..* Creates folders for logs (where your log files are stored), data (where the data set is stored) and plots (where your plots will be stored)
..* Creates and activates the mapping environment
* ```test ```
..* Starts all tests in the test folder
* ```retrieval ```
..* Starts the data set retrieval from TOAR-DB and JOIN
* ```sanitycheck ```
..* Carries out a sanitycheck for your data set
* ```pranalysis ```
..* Preliminary analysis of data set statistics
..* Visualisation of missing values
* ```mapping ```
..* Mapping of the data set (multi layer perceptron)
..* Mapping of the data set (random forest)
## Authors
* Clara Betancourt - [Page](https://www.fz-juelich.de/SharedDocs/Personen/IAS/JSC/EN/staff/betancourt_c.html)
* Scarlet Stadtler - [Page](https://www.fz-juelich.de/SharedDocs/Personen/IAS/JSC/EN/staff/stadtler_s.html)
* Clara Betancourt
* Scarlet Stadtler
* Timo Stomberg
## License
This project is licensed under the MIT License
This project is licensed under the MIT License.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment