tick

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+If you are submitting a feature request, please preface the title with [feature request].
+If you are submitting a bug report, please fill in the following details.
+
+## Issue description
+
+Provide a short description.
+
+## Code example
+
+Please try to provide a minimal example to reproduce the bug.
+Error messages and stack traces are also helpful.
+
+## System Info
+Please copy and paste the output from our
+[environment collection script](https://github.com/sintefneodroid/agent/tree/master/.github/utilities/collect_env.py)
+(or fill out the checklist below manually).
+
+You can get the script and run it with:
+```
+wget https://github.com/sintefneodroid/neo/tree/master/.github/utilities/collect_env.py
+# For security purposes, please check the contents of collect_env.py before running it.
+python collect_env.py
+```
+
+- How you installed NeodroidAgent (conda, pip, source):
+- Build command you used (if compiling from source):
+- OS:
+- NeodroidAgent version:
+- Python version:
+- GPU models and configuration:
+- GCC version (if compiling from source):
+- CMake version:
+- Versions of any other relevant libraries:

.github/utilities/collect_env.py

@@ -0,0 +1,243 @@
+# Borrowed for PyTorch repo
+# This script outputs relevant system environment info
+# Run it with `python collect_env.py`.
+import re
+import subprocess
+import sys
+from collections import namedtuple
+
+import neodroidagent
+from setup import NeodroidAgentPackage
+
+PY3 = sys.version_info >= (3, 0)
+
+# System Environment Information
+SystemEnv = namedtuple(
+    "SystemEnv",
+    [
+        "neo_version",
+        "is_a_development_build",
+        "os",
+        "python_version",
+        "pip_version",  # 'pip' or 'pip3'
+        "pip_packages",
+    ],
+)
+
+
+def run_cmd(command):
+    """Returns (return-code, stdout, stderr)"""
+    p = subprocess.Popen(
+        command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True
+    )
+    output, err = p.communicate()
+    rc = p.returncode
+    if PY3:
+        output = output.decode("ascii")
+        err = err.decode("ascii")
+    return rc, output.strip(), err.strip()
+
+
+def run_and_read_all(run_lambda, command):
+    """Runs command using run_lambda; reads and returns entire output if rc is 0"""
+    rc, out, _ = run_lambda(command)
+    if rc is not 0:
+        return None
+    return out
+
+
+def run_and_parse_first_match(run_lambda, command, regex):
+    """Runs command using run_lambda, returns the first regex match if it exists"""
+    rc, out, _ = run_lambda(command)
+    if rc is not 0:
+        return None
+    match = re.search(regex, out)
+    if match is None:
+        return None
+    return match.group(1)
+
+
+def get_platform():
+    if sys.platform.startswith("linux"):
+        return "linux"
+    elif sys.platform.startswith("win32"):
+        return "win32"
+    elif sys.platform.startswith("cygwin"):
+        return "cygwin"
+    elif sys.platform.startswith("darwin"):
+        return "darwin"
+    else:
+        return sys.platform
+
+
+def get_mac_version(run_lambda):
+    return run_and_parse_first_match(run_lambda, "sw_vers -productVersion", r"(.*)")
+
+
+def get_windows_version(run_lambda):
+    return run_and_read_all(run_lambda, "wmic os get Caption | findstr /v Caption")
+
+
+def get_lsb_version(run_lambda):
+    return run_and_parse_first_match(
+        run_lambda, "lsb_release -a", r"Description:\t(.*)"
+    )
+
+
+def check_release_file(run_lambda):
+    return run_and_parse_first_match(
+        run_lambda, "cat /etc/*-release", r'PRETTY_NAME="(. *)"'
+    )
+
+
+def get_os(run_lambda):
+    platform = get_platform()
+
+    if platform is "win32" or platform is "cygwin":
+        return get_windows_version(run_lambda)
+
+    if platform == "darwin":
+        version = get_mac_version(run_lambda)
+        if version is None:
+            return None
+        return f"Mac OSX {version}"
+
+    if platform == "linux":
+        # Ubuntu/Debian based
+        desc = get_lsb_version(run_lambda)
+        if desc is not None:
+            return desc
+
+        # Try reading /etc/*-release
+        desc = check_release_file(run_lambda)
+        if desc is not None:
+            return desc
+
+        return platform
+
+    # Unknown platform
+    return platform
+
+
+def req_grep_fmt():
+    r = "\|".join(
+        [
+            f'{req.split(">")[0].split("=")[0]}'
+            for req in (
+                NeodroidAgentPackage.extras["all"] + NeodroidAgentPackage.requirements
+            )
+        ]
+    )
+    return r
+
+
+def get_pip_packages(run_lambda):
+    # People generally have `pip` as `pip` or `pip3`
+    def run_with_pip(pip):
+        return run_and_read_all(
+            run_lambda,
+            pip + f' list - -format=legacy | grep "Neodroid\|{req_grep_fmt()}"',
+        )
+
+    if not PY3:
+        return "pip", run_with_pip("pip")
+
+    # Try to figure out if the user is running pip or pip3.
+    out2 = run_with_pip("pip")
+    out3 = run_with_pip("pip3")
+
+    number_of_pips = len([x for x in [out2, out3] if x is not None])
+    if number_of_pips is 0:
+        return "pip", out2
+
+    if number_of_pips == 1:
+        if out2 is not None:
+            return "pip", out2
+        return "pip3", out3
+
+    # num_pips is 2. Return pip3 by default b/c that most likely
+    # is the one associated with Python 3
+    return "pip3", out3
+
+
+def get_env_info():
+    run_lambda = run_cmd
+    pip_version, pip_list_output = get_pip_packages(run_lambda)
+
+    return SystemEnv(
+        neo_version=neodroidagent.__version__,
+        is_a_development_build=neodroidagent.IS_DEVELOP,
+        python_version=f"{sys.version_info[0]}.{sys.version_info[1]}",
+        pip_version=pip_version,
+        pip_packages=pip_list_output,
+        os=get_os(run_lambda),
+    )
+
+
+def pretty_str(env_info):
+    def replace_all_none_objects(dct, replacement="Could not collect"):
+        for key in dct.keys():
+            if dct[key] is not None:
+                continue
+            dct[key] = replacement
+        return dct
+
+    def replace_bools(dct, true="Yes", false="No"):
+        for key in dct.keys():
+            if dct[key] is True:
+                dct[key] = true
+            elif dct[key] is False:
+                dct[key] = false
+        return dct
+
+    def prepend(text, tag="[prepend]"):
+        lines = text.split("\n")
+        updated_lines = [tag + line for line in lines]
+        return "\n".join(updated_lines)
+
+    def replace_if_empty(text, replacement="No relevant packages"):
+        if text is not None and len(text) == 0:
+            return replacement
+        return text
+
+    mutable_dict = env_info._asdict()
+
+    mutable_dict = replace_bools(mutable_dict)  # Replace True with Yes, False with No
+
+    mutable_dict = replace_all_none_objects(
+        mutable_dict
+    )  # Replace all None objects with 'Could not collect'
+
+    mutable_dict["pip_packages"] = replace_if_empty(
+        mutable_dict["pip_packages"]
+    )  # If either of these are '', replace with 'No relevant packages'
+
+    if mutable_dict["pip_packages"]:
+        mutable_dict["pip_packages"] = prepend(
+            mutable_dict["pip_packages"], f"[{env_info.pip_version}] "
+        )
+    return r"""
+Neo version: {neo_version}
+Is a development build: {is_a_development_build}
+OS: {os}
+Python version: {python_version}
+Versions of relevant libraries:
+{pip_packages}
+""".format(
+        **mutable_dict
+    ).strip()
+
+
+def get_pretty_env_info():
+    return pretty_str(get_env_info())
+
+
+def main():
+    print(get_pip_packages(run_cmd))
+    print("Collecting environment information...")
+    output = get_pretty_env_info()
+    print(output)
+
+
+if __name__ == "__main__":
+    main()

MANIFEST.in

@@ -0,0 +1,17 @@
+include requirements*.txt # Include requirements
+
+#include pyproject.toml
+
+# Include the EMDS
+#include *.md
+#recursive-include . *.md
+global-include *.md
+
+
+
+
+# Include the license file
+#include LICENSE.txt
+
+# Include the data files
+#recursive-include data *

__init__.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__author__ = 'Christian Heider Nielsen'
+__doc__ = r'''
+
+           Created on 02-09-2020
+           '''