diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0d92c71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +Copyright (c) 2016-2020 Neuroethology Lab, University of Tuebingen, + Jan Grewe , + Christian Kellner . +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list + of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this + list of conditions and the following disclaimer in the documentation and/or other + materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may + be used to endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT +SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a922151 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# NixView + +A PyQt based viewer for nix datafiles + +--- under development --- + +## Nix + +The nix data model is a generic model for storing scientific data with attached metadata. + +For more information on nix see https://github.com/G-Node/nix + + +## Dependencies + +- PyQt5 +- nixio + diff --git a/nixview/info.json b/nixview/info.json new file mode 100644 index 0000000..f336b9c --- /dev/null +++ b/nixview/info.json @@ -0,0 +1,20 @@ +{ + "NAME": "NixView", + "VERSION": "0.1", + "DESCRIPTION": "Viewer for NIX data files", + "AUTHOR": "Jan Grewe, Lorand Madai-Tahy, Alexander Ott, Christian Kellner", + "COPYRIGHT": "(c) 2020, Neuroethology lab, Uni Tuebingen", + "CONTACT": "jan.grewe@g-node.org", + "HOMEPAGE": "https://github.com/bendalab/nixview-python", + "CLASSIFIERS": [ + "Programming Language :: Python", + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Topic :: Scientific/Engineering", + "Intended Audience :: Science/Research", + "Intended Audience :: End Users/Desktop", + "License :: OSI Approved :: BSD License" + ] +} \ No newline at end of file diff --git a/nixview/info.py b/nixview/info.py new file mode 100644 index 0000000..6aad060 --- /dev/null +++ b/nixview/info.py @@ -0,0 +1,14 @@ +import json +import os + +_HERE = os.path.dirname(__file__) + +with open(os.path.join(_HERE, "info.json")) as infofile: + _INFODICT = json.load(infofile) + +VERSION = _INFODICT["VERSION"] +AUTHOR = _INFODICT["AUTHOR"] +COPYRIGHT = _INFODICT["COPYRIGHT"] +CONTACT = _INFODICT["CONTACT"] +HOMEPAGE = _INFODICT["HOMEPAGE"] +CLASSIFIERS = _INFODICT["CLASSIFIERS"] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..4717cad --- /dev/null +++ b/setup.py @@ -0,0 +1,52 @@ +import glob +import json +import os + +# Use setuptools compulsorily, as the distutils doesn't work out well for the +# installation procedure. The 'install_requires' and 'data_files' have better +# support in setuptools. +from setuptools import setup + + +with open(os.path.join("nixview", "info.json")) as infofile: + infodict = json.load(infofile) + +NAME = infodict["NAME"] +VERSION = infodict["VERSION"] +AUTHOR = infodict["AUTHOR"] +CONTACT = infodict["CONTACT"] +HOMEPAGE = infodict["HOMEPAGE"] +CLASSIFIERS = infodict["CLASSIFIERS"] +DESCRIPTION = infodict["DESCRIPTION"] + +README = "README.md" +with open(README) as f: + description_text = f.read() + +packages = [ + "nixview", +] + +install_req = ["nixio>=1.4.0", "PyQt5"] + +data_files = [("icons", glob.glob(os.path.join("icons", "*.png"))), + ("icons", glob.glob(os.path.join("icons", "*.ic*"))), + (".", ["LICENSE"])] + +setup( + name=NAME, + version=VERSION, + description=DESCRIPTION, + author=AUTHOR, + author_email=CONTACT, + url=HOMEPAGE, + packages=packages, + install_requires=install_req, + include_package_data=True, + data_files=data_files, + long_description=description_text, + long_description_content_type="text/markdown", + classifiers=CLASSIFIERS, + license="BSD", + entry_points={"gui_scripts": ["nixview = nixview:main []"]} +) \ No newline at end of file