add liscence to add files

.github/workflows/deploy-package-to-PyPi.yml

@@ -1,5 +1,7 @@
 # Deploy package to PyPi when a new VERSION is release to the main branch
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 
 name: Upload Python Package to PyPi
 

.github/workflows/publish-documentation.yml

@@ -2,6 +2,8 @@
 # N.B. currently doesn't build the docs: need to do that locally with
 # ./scrips/make_docs.sh
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 
 name: Publish Documentation to Github Pages
 

IQM_Vis/UI/custom_widgets.py

@@ -1,5 +1,7 @@
 ''' Custom SubClasses of PyQt6 widget to extent to the required functionality '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from PyQt6.QtCore import pyqtSignal
 from PyQt6.QtWidgets import QProgressBar, QLabel
 

IQM_Vis/UI/experiment_mode.py

@@ -2,6 +2,8 @@
 create experiment window
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import random
 import threading

IQM_Vis/UI/images.py

@@ -2,6 +2,7 @@
 UI image functions
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
 
 import os
 import imghdr

IQM_Vis/UI/layout.py

@@ -2,6 +2,8 @@
 UI create layout
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import warnings
 from PyQt6.QtWidgets import (QMainWindow,

IQM_Vis/UI/main.py

@@ -2,6 +2,7 @@
 main entry point to initialise the UI
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
 
 import os
 import time

IQM_Vis/UI/style-dark.css

@@ -1,3 +1,6 @@
+/* Author: Matt Clifford <[email protected]> 
+   License: BSD 3-Clause License */
+
 QWidget {
     background-color: "black";
     color: "white";

IQM_Vis/UI/style-light.css

@@ -1,3 +1,6 @@
+/* Author: Matt Clifford <[email protected]> 
+   License: BSD 3-Clause License */
+
 QWidget {
     background-color: "white";
     color: "black";

IQM_Vis/UI/threads.py

@@ -1,6 +1,8 @@
 ''' thread and signal classes to makethe UI smoother
     useful info about PyQt6 threads: https://www.pythontutorial.net/pyqt/pyqt-qthread/'''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from PyQt6.QtCore import QObject, pyqtSignal, pyqtSlot
 from IQM_Vis.utils import plot_utils
 

IQM_Vis/UI/utils.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from PyQt6.QtWidgets import QWidget
 
 

IQM_Vis/UI/widgets.py

@@ -2,6 +2,8 @@
 UI create widgets
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import re
 from functools import partial
 

IQM_Vis/__init__.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from IQM_Vis.ui_wrapper import make_UI
 from IQM_Vis.data_handlers.data_api import dataset_holder
 from IQM_Vis.transformations import transforms

IQM_Vis/data_handlers/__init__.py

@@ -1 +1,4 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from IQM_Vis.data_handlers.data_api_abstract import base_dataloader, base_dataset_loader

IQM_Vis/data_handlers/data_api.py

@@ -3,6 +3,8 @@
 both use the same image for reference and transformed
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import imghdr
 from functools import cache

IQM_Vis/data_handlers/data_api_abstract.py

@@ -2,6 +2,8 @@
 blueprint for data loader API
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from abc import ABC, abstractmethod
 
 class base_dataloader(ABC):

IQM_Vis/examples/all.py

@@ -1,4 +1,7 @@
 ''' run all avaiable metrics/ transforms '''
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import IQM_Vis
 
 def run():

IQM_Vis/examples/dataset.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import numpy as np
 import IQM_Vis

IQM_Vis/examples/dists.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import glob
 import numpy as np

IQM_Vis/examples/experiment.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import numpy as np
 import IQM_Vis

IQM_Vis/examples/kodak.py

@@ -1,4 +1,7 @@
 ''' KODAK dataset '''
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import glob
 import IQM_Vis

IQM_Vis/examples/multiple.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import numpy as np
 import IQM_Vis

IQM_Vis/examples/new_api.py

@@ -1,4 +1,7 @@
 ''' KODAK dataset '''
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import glob
 import IQM_Vis

IQM_Vis/examples/simple.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import numpy as np
 import IQM_Vis

IQM_Vis/metrics/IQMs.py

@@ -2,6 +2,8 @@
 sample metrics to use with the examples of the UI
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import torch
 import torch.nn as nn
 import numpy as np

IQM_Vis/metrics/NLPD_torch/utils/interp1d.py

@@ -1,4 +1,7 @@
 # code dep from https://github.com/aliutkus/torchinterp1d/blob/master/torchinterp1d/interp1d.py
+# Author: Antoine Liutkus
+# License: BSD 3-Clause License
+
 import torch
 import contextlib
 

IQM_Vis/metrics/SSIM/ssim.py

@@ -1,6 +1,9 @@
 # taken from https://github.com/VainF/pytorch-msssim/blob/master/pytorch_msssim/ssim.py
 # Copyright 2020 by Gongfan Fang, Zhejiang University.
 # All rights reserved.
+# Author: Gongfan Fang
+# Licence: MIT
+
 import warnings
 from typing import List, Optional, Tuple, Union
 

IQM_Vis/transformations/transforms.py

@@ -2,6 +2,8 @@
 Sample image transformations to get the user started with
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from skimage.transform import resize, rotate
 from skimage.util import img_as_ubyte
 import cv2

IQM_Vis/ui_wrapper.py

@@ -3,6 +3,8 @@
 TODO: write docs on example usage/ what inputs etc. and what attributes that the data_store class needs
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import subprocess
 import platform
 import sys

IQM_Vis/utils/__init__.py

@@ -1,3 +1,6 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from IQM_Vis.utils.image_utils import *
 from IQM_Vis.utils.plot_utils import bar_plotter, radar_plotter, compute_metrics_over_range_single_trans, get_radar_plots_avg_plots, get_transform_range_plots
 from IQM_Vis.utils.save_utils import *

IQM_Vis/utils/gui_utils.py

@@ -2,6 +2,8 @@
 Utils for PyQt6 image, text and graph widgets
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 try:
     from PyQt6.QtGui import QPixmap, QImage
     import matplotlib; matplotlib.use('Qt5Agg')

IQM_Vis/utils/image_utils.py

@@ -2,6 +2,8 @@
 image helper functions
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import PIL
 import cv2

IQM_Vis/utils/plot_utils.py

@@ -3,6 +3,8 @@
 TODO: write docs how to use these (currently just have to look at the UI code)
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from functools import partial
 import math
 

IQM_Vis/utils/save_utils.py

@@ -2,6 +2,8 @@
 utils for saving experiments, images and figures
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import json
 import pickle

IQM_Vis/version.py

@@ -1,2 +1,5 @@
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 # Changing the version number will action GitHub to push to PyPi the new version
 __version__ = '0.2.5.87'

scripts/create_conda_dev_env.sh

@@ -1,4 +1,7 @@
 #!/usr/bin/bash
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 
 VENV=IQM_Vis
 CONDA_BASE=$(conda info --base)

scripts/get_latest_pypi_version.py

@@ -1,7 +1,8 @@
 #!/bin/python3
-
 '''Get the latest version of a PyPi package'''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import urllib.request
 import sys
 import json

scripts/get_local_version.py

@@ -1,7 +1,8 @@
 #!/bin/python3
-
 '''Get the current version of package locally (github repo) - N.B. needs to be run from root of repo'''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import os
 import sys
 

scripts/make_docs.sh

@@ -1,4 +1,7 @@
 #!/usr/bin/bash
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 
 rm docs/IQM_Vis.*
 # sphinx-build -o docs IQM_Vis

scripts/push_to_pypi.sh

@@ -1,4 +1,7 @@
 #!/usr/bin/bash
+# Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 
 git clean -xfd
 python setup.py sdist bdist_wheel

setup.py

@@ -1,4 +1,6 @@
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 from setuptools import setup, find_packages
 import os
 

tests/test_inputs.py

@@ -2,6 +2,8 @@
 test invalid input to api throws an error
 '''
 # Author: Matt Clifford <[email protected]>
+# License: BSD 3-Clause License
+
 import pytest
 import numpy as np
 
@@ -38,4 +40,4 @@ def test_warn_empty():
         ui._check_inputs()
 
 if __name__ == '__main__':
-    test_inputs()
+    test_not_dict()