bump version to 1.0.4 and fix zenodo and citation files

NLeSC · Jan 16, 2019 · 8b85937 · 8b85937
1 parent ae771f2
commit 8b85937
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 32 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -1,8 +1,4 @@
 {
-    "description": "A deep learning tool for time series classification",
-    "license": "Apache-2.0",
-    "title": "mcfly",
-    "upload_type": "software",
     "creators": [
         {
             "affiliation": "Netherlands eScience Center",
@@ -15,25 +11,25 @@
         {
             "affiliation": "Netherlands eScience Center",
             "name": "van Hees, Vincent",
-            "orchid": "0000-0003-0182-9008"
+            "orcid": "0000-0003-0182-9008"
         },
         {
             "affiliation": "Netherlands eScience Center",
             "name": "Bos, Patrick"
         },
         {
             "affiliation": "Netherlands eScience Center",
-            "name": "Spaaks, Jurriaan H."
+            "name": "Spaaks, Jurriaan"
         },
         {
             "affiliation": "Netherlands eScience Center",
             "name": "Kuzak, Mateusz",
-            "orchid": "0000-0003-0087-6021"
+            "orcid": "0000-0003-0087-6021"
         },
         {
             "affiliation": "Netherlands eScience Center",
             "name": "Huber, Florian",
-            "orchid": "0000-0002-3535-9406"
+            "orcid": "0000-0002-3535-9406"
         },
         {
             "affiliation": "Netherlands eScience Center",
@@ -44,11 +40,15 @@
             "name": "van der Ploeg, Atze"
         }
     ],
-    "access_right": "open",
+    "description": "The goal of mcfly is to ease the use of deep learning technology for time series classification. The advantage of deep learning is that it can handle raw data directly, without the need to compute signal features. Deep learning does not require expert domain knowledge about the data, and has been shown to be competitive with conventional machine learning techniques. As an example, you can apply mcfly on accelerometer data for activity classification.",
     "keywords": [
-          "machine learning",
-          "deep learning",
-          "time series",
-          "automatic classification"
-    ]
+        "machine learning",
+        "deep learning",
+        "time series",
+        "automated machine learning"
+    ],
+    "license": {
+        "id": "Apache-2.0"
+    },
+    "title": "mcfly: deep learning for time series"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Change Log
 
+## v1.0.4
+- Fixed Zenodo configuration
+
 ## v1.0.3
 - Requirements change (six>=1.10.0)
 - Fixed Zenodo configuration

diff --git a/CITATION.cff b/CITATION.cff
@@ -1,36 +1,59 @@
 # YAML 1.2
---- 
-authors: 
-  - 
+---
+abstract: "The goal of mcfly is to ease the use of deep learning technology for time series classification. The advantage of deep learning is that it can handle raw data directly, without the need to compute signal features. Deep learning does not require expert domain knowledge about the data, and has been shown to be competitive with conventional machine learning techniques. As an example, you can apply mcfly on accelerometer data for activity classification."
+authors:
+  -
     affiliation: "Netherlands eScience Center"
     family-names: Kuppevelt
     given-names: Dafne
     name-particle: van
-  - 
+  -
     affiliation: "Netherlands eScience Center"
     family-names: Meijer
     given-names: Christiaan
-  - 
+  -
     affiliation: "Netherlands eScience Center"
     family-names: Hees
     given-names: Vincent
     name-particle: van
-  - 
+    orcid: "https://orcid.org/0000-0003-0182-9008"
+  -
+    affiliation: "Netherlands eScience Center"
+    family-names: Bos
+    given-names: Patrick
+  -
+    affiliation: "Netherlands eScience Center"
+    family-names: Spaaks
+    given-names: Jurriaan
+  -
     affiliation: "Netherlands eScience Center"
     family-names: Kuzak
     given-names: Mateusz
     orcid: "https://orcid.org/0000-0003-0087-6021"
+  -
+    affiliation: "Netherlands eScience Center"
+    family-names: Huber
+    given-names: Florian
+    orcid: "https://orcid.org/0000-0002-3535-9406"
+  -
+    affiliation: "Netherlands eScience Center"
+    family-names: Hidding
+    given-names: Johan
+  -
+    affiliation: "Netherlands eScience Center"
+    family-names: Ploeg
+    given-names: Atze
+    name-particle: "van der"
 cff-version: "1.0.3"
-commit: 95c5a7f76525655562baeca0af8d334d1796bf57
-date-released: 2017-04-06
-doi: 10.5281/zenodo.495345
-keywords: 
+date-released: 2018-01-16
+doi: "10.5281/zenodo.596127"
+keywords:
   - "machine learning"
   - "deep learning"
   - "time series"
-  - "automatic classification"
-license: Apache-2.0
+  - "automated machine learning"
+license: "Apache-2.0"
 message: "If you use this software, please cite it using these metadata."
-repository-code: "https://github.com/NLeSC/mcfly"
-title: mcfly
-version: "1.0.1"
+title: "mcfly: deep learning for time series"
+version: "1.0.4"
+...
diff --git a/mcfly/_version.py b/mcfly/_version.py
@@ -15,4 +15,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = '1.0.3'
+__version__ = '1.0.4'
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
     exec(versionpy.read())
 
 def read(fname):
-    return list(open(os.path.join(os.path.dirname(__file__), fname)).readlines())
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
 
 with open('requirements.txt') as f:
     required = f.read().splitlines()
@@ -19,7 +19,8 @@ def read(fname):
     url = "https://github.com/NLeSC/mcfly",
     packages=['mcfly'],
     install_requires=required,
-    long_description='\n'.join(read('README.md')[12:]),
+    long_description=read('README.md'),
+    long_description_content_type='text/markdown',
     classifiers=[
         'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python',