Merge branch 'master' into ace-airsea-update

Swiss-Polar-Institute · May 14, 2020 · 66adce6 · 66adce6
2 parents 0ed488d + be55aa4
commit 66adce6
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 153 deletions.
diff --git a/README.rst b/README.rst
@@ -11,13 +11,16 @@ Usage
 .. code-block:: python
 
     import pyantarctica
-    import pyantarctica.dataset as data
-    import pyantarctica.modeling as mod
-    import pyantarctica.visualizing as viz
+    from pyantarctica import aiceairsea 
+    from pyantarctica import datafilter
+    from pyantarctica import dataset
+    from pyantarctica import visualizing
+    from pyantarctica import windvectorcoordinates
+
 
 Every notebook in the ACE-DATA data science project repository provides relatively simple (hopefully) and straightforward examples and scripts to run steps in the ASAID project analysis pipeline.
 
-See e.g. data preparation scrips ``PROJ_XX_DataPreparation.ipynb`` where XX is the subproject number.
+See scripts released with publications
 
 Setup
 *****
@@ -28,53 +31,42 @@ If you are using conda, first set up a conda environment:
 
 .. code-block:: console
 
-    $ conda create --name ace-data python=3
+    $ conda create --name ace-data python=3.6
     $ conda activate ace-data
 
-To install the pyanctarctica package, run (base 0.1.0 is on PyPI)
+Install the pyanctarctica package
+*********************************
+
 
 From source:
 
 .. code-block:: console
 
     $ cd YOUR_PROJECT_FOLDER
     $ mkdir src && cd src
-    $ git clone ./src
-    $ pip install src
-
-From the gitlab repo  `gitlab.datascience.ch/ACE-ASAID/pyanctarctica.git <https://gitlab.datascience.ch/ACE-ASAID/pyantarctica>`_:
-
-.. code-block:: console
-
-    $ pip install -e [email protected]:ACE-ASAID/pyantarctica.git
+    $ git clone [email protected]:Swiss-Polar-Institute/pyantarctica.git
+    $ pip install ./pyantarctica
 
-From the PyPI repos:
+From the Swiss Polar Institute Github Repository https://github.com/Swiss-Polar-Institute/pyantarctica :
 
 .. code-block:: console
 
-    $ pip install pyantarctica
+    $ pip install -e [email protected]:Swiss-Polar-Institute/pyantarctica.git
 
 Documentation
 *************
 
-Read the documentation `here <./docs/build/index.html>`_!
-
-Release process
-***************
-
-1. Update version in `setup.py`, commit and tag.
-2. Run `rm -rf dist && python setup.py sdist bdist_wheel && twine upload dist/*`
-3. Change the bump of the version to development (`X.Y.Z+1.devYYYYMMDD`)
+Can be built with `sphinx`
 
 Compatibility
 **************
 
-Python 3 preferred, but not required.
+Python 3.3 preferred, but not required. Only tested with python >= 3
 
 License
 *******
 
-Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 
 A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and Eidgenössische Technische Hochschule Zürich (ETHZ).
 
@@ -94,17 +86,4 @@ Authors
 Requirements
 ************
 
-(Does not include sub-package dependencies)
-
-.. code-block:: console
-
-    pyantarctica
-    ~~Cartopy==0.16.0~~
-    ~~GPy==1.9.2~~
-    matplotlib==2.2.2
-    numpy==1.14.5
-    pandas==0.23.0
-    papermill==0.12.6
-    pickleshare==0.7.4
-    scikit-learn==0.19.1
-    scipy==1.1.0
+see `setup.py`
diff --git a/pyantarctica/aceairsea.py b/pyantarctica/aceairsea.py
@@ -1,18 +1,7 @@
-# *** aceairsea.py ***
 #
-# a collection of useful functions based on air-sea literature
-# written by Sebastian Landwehr^{1,2} for the ACE-DATA/ASAID project (PI Julia Schmale^{1,2})
-# {1} Paul Scherrer Institute, Laboratory of Atmospheric Chemistry, Villigen, Switzerland
-# {2} Extreme Environments Research Laboratory,  École Polytechnique Fédérale de Lausanne, School of Architecture, Civil and Environmental Engineering, Lausanne, Switzerland
-#
-# the function make use of the airsea toolbox of Filipe Fernandes
-# - # pip install airsea
-# - # https://github.com/pyoceans/python-airsea
-# - # https://pypi.org/project/airsea/
-#
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/pyantarctica/backtrajectories.py b/pyantarctica/backtrajectories.py
@@ -1,11 +1,26 @@
-# collection of functions to handle back trajectory data
+#
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
+# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import os
 from pathlib import Path
 from collections import defaultdict
 
 import datetime 
 
-
 import numpy as np
 import pandas as pd
 

diff --git a/pyantarctica/data_lut.py b/pyantarctica/data_lut.py
diff --git a/pyantarctica/datafilter.py b/pyantarctica/datafilter.py
@@ -1,12 +1,7 @@
-# *** datafilter.py ***
-# a collection of useful functions to filter spikes out of data
-# written by Sebastian Landwehr^{1,2} for the ACE-DATA/ASAID project (PI Julia Schmale^{1,2})
-# {1} Paul Scherrer Institute, Laboratory of Atmospheric Chemistry, Villigen, Switzerland
-# {2} Extreme Environments Research Laboratory,  École Polytechnique Fédérale de Lausanne, School of Architecture, Civil and Environmental Engineering, Lausanne, Switzerland
 #
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+
 import numpy as np
 import pandas as pd
 

diff --git a/pyantarctica/dataset.py b/pyantarctica/dataset.py
@@ -1,7 +1,7 @@
 #
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/pyantarctica/seaspraysourcefunction.py b/pyantarctica/seaspraysourcefunction.py
@@ -1,13 +1,7 @@
-# *** seaspraysourcefunction.py ***
-# a collection of useful functions for dealing with sea spray data
 #
-# written by Sebastian Landwehr^{1,2} for the ACE-DATA/ASAID project (PI Julia Schmale^{1,2})
-# {1} Paul Scherrer Institute, Laboratory of Atmospheric Chemistry, Villigen, Switzerland
-# {2} Extreme Environments Research Laboratory,  École Polytechnique Fédérale de Lausanne, School of Architecture, Civil and Environmental Engineering, Lausanne, Switzerland
-#
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/pyantarctica/visualizing.py b/pyantarctica/visualizing.py
@@ -1,7 +1,7 @@
 #
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/pyantarctica/windvectorcoordinates.py b/pyantarctica/windvectorcoordinates.py
@@ -1,12 +1,7 @@
-# *** windvectorcoordinates.py ***
-# a collection of useful functions to deal with wind vector data and GPS coordiates
-# written by Sebastian Landwehr^{1,2} for the ACE-DATA/ASAID project (PI Julia Schmale^{1,2})
-# {1} Paul Scherrer Institute, Laboratory of Atmospheric Chemistry, Villigen, Switzerland
-# {2} Extreme Environments Research Laboratory,  École Polytechnique Fédérale de Lausanne, School of Architecture, Civil and Environmental Engineering, Lausanne, Switzerland
 #
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/setup.py b/setup.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2017-2018 - Swiss Data Science Center (SDSC)
+# Copyright 2017-2018 - Swiss Data Science Center (SDSC) and ACE-DATA/ASAID Project consortium. 
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
-# Eidgenössische Technische Hochschule Zürich (ETHZ).
+# Eidgenössische Technische Hochschule Zürich (ETHZ). Written within the scope 
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,27 +23,28 @@
 # 'Cartopy==0.16.0',
 
 install_requires = []
-# 'matplotlib,
-# 'numpy',
-# 'pandas==0.23.0',
-# 'pickleshare',
-# 'scikit-learn',
-# 'holoviews',
-# 'geoviews',
-# 'bokeh'
-# ]
+'matplotlib,
+'numpy',
+'pandas==0.23.0',
+'holoviews',
+'cartopy',
+'geoviews',
+'bokeh', 
+'airsea',
+'pathlib'
+]
 
 tests_require = []
 
 extras_require = {}
 
 setup(
     name="pyantarctica",
-    version="0.1.3.1",
+    version="0.1.0",
     license="Apache License 2.0",
     url="",
 
-    author="Michele Volpi, Swiss Data Science Center (SDSC)",
+    author="Michele Volpi, Swiss Data Science Center (SDSC, ETHZ and EPFL); Sebastian Landwehr (Extreme Environments Research Laboratory, EPFL)",
     author_email="[email protected]",
 
     description="Umbrella package for ACE-DATA ASAID (sub-)project(s).",