Added copyright notices and docstrings to new files

philipstarkey · philipstarkey · commit 5ea15e8b15e9 · 2024-01-27T16:05:28.000+11:00
diff --git a/labscript/base.py b/labscript/base.py
@@ -1,3 +1,18 @@
+#####################################################################
+#                                                                   #
+# /base.py                                                          #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""The labscript base class for all I/O/Device classes"""
+
 import builtins
 import keyword
 
diff --git a/labscript/compiler.py b/labscript/compiler.py
@@ -1,3 +1,19 @@
+#####################################################################
+#                                                                   #
+# /compiler.py                                                      #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""The labscript compiler interface. This is only relevant to developers and those
+interested in the labscript interface to runmanager."""
+
 import builtins
 
 from labscript_utils.labconfig import LabConfig
diff --git a/labscript/constants.py b/labscript/constants.py
@@ -1,8 +1,38 @@
+#####################################################################
+#                                                                   #
+# /constants.py                                                     #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""Common constant factors for time and frequency"""
+
 ns = 1e-9
+"""Conversion factor between nanoseconds and seconds"""
+
 us = 1e-6
+"""Conversion factor between microseconds and seconds"""
+
 ms = 1e-3
+"""Conversion factor between milliseconds and seconds"""
+
 s = 1
+"""Conversion factor between seconds and seconds"""
+
 Hz = 1
+"""Conversion factor between hertz and hertz"""
+
 kHz = 1e3
+"""Conversion factor between kilohertz and hertz"""
+
 MHz = 1e6
-GHz = 1e9
+"""Conversion factor between megahertz and hertz"""
+
+GHz = 1e9
+"""Conversion factor between gigahertz and hertz"""
diff --git a/labscript/core.py b/labscript/core.py
@@ -1,3 +1,19 @@
+#####################################################################
+#                                                                   #
+# /core.py                                                          #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""Core classes containing common device functionality. These are used in
+labscript-devices when adding support for a hardware device."""
+
 import sys
 
 import numpy as np
diff --git a/labscript/functions.py b/labscript/functions.py
@@ -11,6 +11,9 @@
 #                                                                   #
 #####################################################################
 
+"""Contains the functional forms of analog output ramps. These are not used directly,
+instead see the interfaces in `AnalogQuantity`/`AnalogOut`."""
+
 from pylab import *
 import numpy as np
 
diff --git a/labscript/inputs.py b/labscript/inputs.py
@@ -1,3 +1,16 @@
+#####################################################################
+#                                                                   #
+# /inputs.py                                                        #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
 """Classes for device channels that are inputs"""
 
 from .base import Device
diff --git a/labscript/labscript.py b/labscript/labscript.py
@@ -11,6 +11,9 @@
 #                                                                   #
 #####################################################################
 
+"""Everything else including the `start()`, `stop()`, and `wait()` functions. All other
+classes are also imported here for backwards compatibility"""
+
 import builtins
 import os
 import sys
diff --git a/labscript/outputs.py b/labscript/outputs.py
@@ -1,4 +1,17 @@
-"""Classes for devices channels that out outputs"""
+#####################################################################
+#                                                                   #
+# /outputs.py                                                       #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""Classes for devices channels that are outputs"""
 
 import sys
 
diff --git a/labscript/remote.py b/labscript/remote.py
@@ -1,3 +1,18 @@
+#####################################################################
+#                                                                   #
+# /remote.py                                                        #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""Classes for configuring remote/secondary BLACS and/or device workers"""
+
 from .compiler import compiler
 from .labscript import Device, set_passed_properties
 
diff --git a/labscript/utils.py b/labscript/utils.py
@@ -1,3 +1,18 @@
+#####################################################################
+#                                                                   #
+# /utils.py                                                         #
+#                                                                   #
+# Copyright 2013, Monash University                                 #
+#                                                                   #
+# This file is part of the program labscript, in the labscript      #
+# suite (see http://labscriptsuite.org), and is licensed under the  #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+
+"""Utility functions"""
+
 import contextlib
 from inspect import getcallargs
 from functools import wraps
