From e7bddde7a41d2a9f939f2606994a4fbb5b7b8b3e Mon Sep 17 00:00:00 2001
From: leufen1 <l.leufen@fz-juelich.de>
Date: Thu, 8 Oct 2020 10:41:45 +0200
Subject: [PATCH] updated readme, introcuded supplement folder to cleanup root
folder a bit
---
LICENSE | 2 +-
README.md | 4 +++-
run_zam347.py | 2 +-
.../Examples_from_manuscript.ipynb | 0
.../German_background_stations.json | 0
.../development_guidelines.md | 0
6 files changed, 5 insertions(+), 3 deletions(-)
rename Examples_from_manuscript.ipynb => supplement/Examples_from_manuscript.ipynb (100%)
rename German_background_stations.json => supplement/German_background_stations.json (100%)
rename development_guidelines.md => supplement/development_guidelines.md (100%)
diff --git a/LICENSE b/LICENSE
index a79ea789..11849c4f 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2020 Lukas Leufen
+Copyright (c) Forschungszentrum Jülich GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index c56baeea..43fb50cd 100644
--- a/README.md
+++ b/README.md
@@ -83,7 +83,9 @@ The installation on Windows is not tested yet.
In this section, we show three examples how to work with MLAir. Note, that for these examples MLAir was installed using
the distribution file. In case you are using the git clone it is required to adjust the import path if not directly
-executed inside the source directory of MLAir.
+executed inside the source directory of MLAir. There is also a downloadable
+[Jupyter Notebook](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/supplement/Examples_from_manuscript.ipynb)
+provided in that you can run the following examples. Note that this notebook still requires an installation of MLAir.
## Example 1
diff --git a/run_zam347.py b/run_zam347.py
index 9027bec8..352f0417 100644
--- a/run_zam347.py
+++ b/run_zam347.py
@@ -16,7 +16,7 @@ from mlair.workflows import DefaultWorkflowHPC
def load_stations():
try:
- filename = 'German_background_stations.json'
+ filename = 'supplement/German_background_stations.json'
with open(filename, 'r') as jfile:
stations = json.load(jfile)
logging.info(f"load station IDs from file: {filename} ({len(stations)} stations)")
diff --git a/Examples_from_manuscript.ipynb b/supplement/Examples_from_manuscript.ipynb
similarity index 100%
rename from Examples_from_manuscript.ipynb
rename to supplement/Examples_from_manuscript.ipynb
diff --git a/German_background_stations.json b/supplement/German_background_stations.json
similarity index 100%
rename from German_background_stations.json
rename to supplement/German_background_stations.json
diff --git a/development_guidelines.md b/supplement/development_guidelines.md
similarity index 100%
rename from development_guidelines.md
rename to supplement/development_guidelines.md
--
GitLab