Skip to content

Commit 5ea15e8

Browse files
philipstarkeyphilipstarkey
committed
Added copyright notices and docstrings to new files
1 parent 5c04f42 commit 5ea15e8

File tree

10 files changed

+141
-2
lines changed

10 files changed

+141
-2
lines changed

‎labscript/base.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
#####################################################################
2+
# #
3+
# /base.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""The labscript base class for all I/O/Device classes"""
15+
116
import builtins
217
import keyword
318

‎labscript/compiler.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
#####################################################################
2+
# #
3+
# /compiler.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""The labscript compiler interface. This is only relevant to developers and those
15+
interested in the labscript interface to runmanager."""
16+
117
import builtins
218

319
from labscript_utils.labconfig import LabConfig

‎labscript/constants.py‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,38 @@
1+
#####################################################################
2+
# #
3+
# /constants.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""Common constant factors for time and frequency"""
15+
116
ns = 1e-9
17+
"""Conversion factor between nanoseconds and seconds"""
18+
219
us = 1e-6
20+
"""Conversion factor between microseconds and seconds"""
21+
322
ms = 1e-3
23+
"""Conversion factor between milliseconds and seconds"""
24+
425
s = 1
26+
"""Conversion factor between seconds and seconds"""
27+
528
Hz = 1
29+
"""Conversion factor between hertz and hertz"""
30+
631
kHz = 1e3
32+
"""Conversion factor between kilohertz and hertz"""
33+
734
MHz = 1e6
8-
GHz = 1e9
35+
"""Conversion factor between megahertz and hertz"""
36+
37+
GHz = 1e9
38+
"""Conversion factor between gigahertz and hertz"""

‎labscript/core.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
#####################################################################
2+
# #
3+
# /core.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""Core classes containing common device functionality. These are used in
15+
labscript-devices when adding support for a hardware device."""
16+
117
import sys
218

319
import numpy as np

‎labscript/functions.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
# #
1212
#####################################################################
1313

14+
"""Contains the functional forms of analog output ramps. These are not used directly,
15+
instead see the interfaces in `AnalogQuantity`/`AnalogOut`."""
16+
1417
from pylab import *
1518
import numpy as np
1619

‎labscript/inputs.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
#####################################################################
2+
# #
3+
# /inputs.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
114
"""Classes for device channels that are inputs"""
215

316
from .base import Device

‎labscript/labscript.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
# #
1212
#####################################################################
1313

14+
"""Everything else including the `start()`, `stop()`, and `wait()` functions. All other
15+
classes are also imported here for backwards compatibility"""
16+
1417
import builtins
1518
import os
1619
import sys

‎labscript/outputs.py‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
"""Classes for devices channels that out outputs"""
1+
#####################################################################
2+
# #
3+
# /outputs.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""Classes for devices channels that are outputs"""
215

316
import sys
417

‎labscript/remote.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
#####################################################################
2+
# #
3+
# /remote.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""Classes for configuring remote/secondary BLACS and/or device workers"""
15+
116
from .compiler import compiler
217
from .labscript import Device, set_passed_properties
318

‎labscript/utils.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
#####################################################################
2+
# #
3+
# /utils.py #
4+
# #
5+
# Copyright 2013, Monash University #
6+
# #
7+
# This file is part of the program labscript, in the labscript #
8+
# suite (see http://labscriptsuite.org), and is licensed under the #
9+
# Simplified BSD License. See the license.txt file in the root of #
10+
# the project for the full license. #
11+
# #
12+
#####################################################################
13+
14+
"""Utility functions"""
15+
116
import contextlib
217
from inspect import getcallargs
318
from functools import wraps

0 commit comments

Comments
 (0)