Add licence text to all source files (#412)

* Add licence text to all source files

* Add a note about the license comment to contribution guidelines

* Add a note about experimental libraries

Author: chrisib

contributing.md

@@ -163,11 +163,11 @@ Just write any labels that apply to your program, including any not listed here
 
 ### File Naming
 
-Please use all lowercase and separate words with underscores for your program names. If additional resources are needed, such as image files, a directory with the same name and suffixed with `docs` can be included. e.g. the files associated with a program for a Sample and Hold function would look as follows:
+Please use all lowercase and separate words with underscores for your program names. If additional resources are needed, such as image files, a directory with the same name and suffixed with `-docs` can be included. e.g. the files associated with a program for a Sample and Hold function would look as follows:
 
 ```
 software/contrib
-├── sample_and_hold_docs
+├── sample_and_hold-docs
 │   └── sample_and_hold.png
 ├── sample_and_hold.md
 ├── sample_and_hold.py
@@ -177,12 +177,33 @@ software/contrib
 
 In order to be included in the menu a program needs to meet a few additional requirements. See [menu.md](/software/contrib/menu.md) for details. Programs are not required to participate in the menu in order to be accepted, but it is nice.
 
-
-
 ## Firmware
 
 Changes to firmware code must adhere to more stringent requirements than other changes. Firmware changes have the potential to affect every contrib script that runs on the EuroPi as well as the behavior of the module itself. Any change must have a clear and well described purpose and be well tested against the suite of available contrib scripts.
 
+### Experimental Libraries
+
+User-contributed additions to the firmware, or code intended to be re-used across multiple `contrib` programs should be placed in the `firmware/experimental` directory:
+
+```
+software/
+├── contrib/
+│   └── my_program.md
+│   └── my_program.py
+│   └── your_program.md
+├── firmware/
+│   ├── experimental/
+│   |   └── my_common_features.py
+```
+
+Examples of user-contributed shared code include:
+- lockable knobs
+- screensaver
+- quantizer
+- euclidean pattern generator
+- custom fonts
+- additional `math` and `random` functions included in standard Python3, but not included in MicroPython
+
 ### Code Style Requirements
 
 The main codebase (all code outside of `/software/contrib` and `/tests/contrib`) follows the Black style format and a GitHub CI Action will verify if this is the case for
@@ -203,3 +224,25 @@ Changes or additions to public API functions must include the corresponding upda
 ### Testing
 
 All existing automated tests must pass. An effort should be made to improve the test suite by adding tests for new or changed functionality.
+
+## License
+
+All software in this repository is licensed under the [Apache 2.0](/software/LICENSE) license. In accordance with this license, please place a comment block at the top of your Python source files indicating the copyright and license:
+
+```python
+# Copyright [YEAR] Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+```
+
+Please substitute `[YEAR]` with the current year, e.g. `2025`.

software/contrib/arp.py

@@ -1,4 +1,17 @@
 #!/usr/bin/env python3
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """Arpeggiator & ascending/descending scale generator
 
 Outputs ascending/descending quantized CV, with additional outputs

software/contrib/bernoulli_gates.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from time import sleep_ms
 from random import random
@@ -218,4 +231,4 @@ def main(self):
 
 if __name__ == "__main__":
     bernoulli_gates = BernoulliGates()
-    bernoulli_gates.main()
+    bernoulli_gates.main()

software/contrib/bezier.py

@@ -1,4 +1,17 @@
 #!/usr/bin/env python3
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """
 Generates random voltages based on Bezier curves
 

software/contrib/binary_counter.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from europi_script import EuroPiScript
 

software/contrib/bit_garden.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 try:
     # Local development
     from software.firmware import europi_config

software/contrib/clock_mod.py

@@ -1,4 +1,17 @@
 #!/usr/bin/env python3
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """Clock multiplier & divider
 """
 

software/contrib/coin_toss.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from random import random
 from time import sleep_ms, ticks_ms, ticks_add, ticks_diff

software/contrib/consequencer.py

@@ -1,3 +1,16 @@
+# Copyright 2022 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 import machine
 from time import ticks_diff, ticks_ms

software/contrib/conway.py

@@ -1,4 +1,17 @@
 #!/usr/bin/env python3
+# Copyright 2023 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """Implements Conway's Game of Life as a pseudo-random LFO kernel
 
 Outputs 1-3 are 0-10V control voltages, outputs 4-6 are 5V gates

software/contrib/custom_font_demo.py

@@ -1,3 +1,16 @@
+# Copyright 2023 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """
 Custom font demo
 author: François Georgy (https://github.com/francoisgeorgy)
@@ -76,4 +89,4 @@ def main(self):
 
 if __name__ == "__main__":
     oled.contrast(0)  # dim the display
-    CustomFontDemo().main()
+    CustomFontDemo().main()

software/contrib/cvecorder.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from time import ticks_diff, ticks_ms, sleep_ms
 from random import randint, uniform
@@ -473,4 +486,4 @@ def updateScreen(self):
 
 if __name__ == '__main__':
     dm = CVecorder()
-    dm.main()
+    dm.main()

software/contrib/daily_random.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from europi_script import EuroPiScript
 

software/contrib/dscn2.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """
 Binary tree based looping gate sequencer
 """

software/contrib/egressus_melodiam.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 import machine
 from time import ticks_diff, ticks_ms

software/contrib/envelope_generator.py

@@ -1,3 +1,16 @@
+# Copyright 2024 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 from europi import *
 from europi_script import EuroPiScript
 

software/contrib/euclid.py

@@ -1,12 +1,21 @@
 #!/usr/bin/env python3
+# Copyright 2023 Allen Synthesis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 """Euclidean rhythm generator for the EuroPi
 
 @author Chris Iverach-Brereton <[email protected]>
-@author Brian House
-@year   2011, 2023
-
-This script contains code released under the MIT license, as
-noted below
+@year   2023
 """
 
 import random