From d89a92754f5f6d9ee7a07fd3638ed825b9af09b8 Mon Sep 17 00:00:00 2001 From: Anthony Truskinger Date: Sun, 18 Feb 2018 02:19:54 +1000 Subject: [PATCH] Adds an open source license to the repo Also cleans up the main README a bit. Work done for #140 --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 69 ++++++- LICENSE.txt | 201 +++++++++++++++++++++ README.md | 114 +++++------- docs/README.MD | 7 +- 4 files changed, 312 insertions(+), 79 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (53%) create mode 100644 LICENSE.txt diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 53% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index 67681e7dc..2aef5f2fd 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,53 @@ Contributing to audio-analysis ========================= +Best Practices +-------------- + +- Set the git `autocrlf` config setting. See + for instructions. +- Avoid adding binary content to this repository. If it must be added, ensure git-lfs is tracking it. +- NEVER commit if the code does not build to the `master` branch +- Try to work on branches if your code negatively affects production code +- Write code in American English. Documentation may be written in Australian English. + +Required Software +----------------- + +The required software for devleoping new code (not running the program) includes: + +- A Windows OS (we're working on making this Linux compatible) +- Visual Studio 2017 +- [Optional] Resharper Ulitmate (Academic License) + - Install these plugins (_ReSharper_ menu > _Extension Manager_) + - ReSpeller Free +- [msysgit](https://git-for-windows.github.io/) + +Binary Large Objects (BLOBs) +---------------------------- + +We use [git-lfs](https://git-lfs.github.com/) to store BLOBs for testing audio +file converters. If you want to run the unit tests you need to have git-lfs +installed. + +Not all BLOBs are stored in git-lfs. So far only the audio files in +`tests\Fixtures` have been added. + + +Third party contributions +------------------------- + +Third party contributions should be made by: + +- forking the repository +- making changes in a branch +- submitting a pull-request to merge those changes from your-fork and branch, to our copy and master branch + Help wanted ------------ -We mark the most straightforward issues as "help wanted". This set of issues is the place to start if you are interested in contributing but new to the codebase. +We mark the most straightforward issues as "help wanted". This set of issues is the place to start if you are interested +in contributing but new to the codebase. - [QutEcoacoustics/audio-analysis - "up for grabs"](https://github.com/QutEcoacoustics/audio-analysis/labels/up%20for%20grabs) @@ -16,15 +59,18 @@ Project maintainers will merge changes that improve the product significantly an Contributions must also satisfy the other published guidelines defined in this document. +We will gladly accept any documentation enhancements. + DOs and DON'Ts -------------- Please do: -* **DO** follow our (enforce by StyleCop) -* **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. -* **DO** include tests when adding new features. When fixing bugs, start with - adding a test that highlights how the current behavior is broken. +* **DO** follow our style (enforced by StyleCop) +* **DO** give priority to the current style of the project or file you're changing even if it diverges from the general + guidelines. +* **DO** include tests when adding new features. When fixing bugs, start with adding a test that highlights how the + current behavior is broken. * **DO** keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion. * **DO** blog and tweet (or whatever) about your contributions, frequently! @@ -35,8 +81,9 @@ Please do not: * **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time. -* **DON'T** commit code that you didn't write. If you find code that you think is a good fit, file an issue and start a discussion before proceeding. -* **DON'T** submit PRs that alter licensing related files or headers. +* **DON'T** commit code that you didn't write. If you find code that you think is a good fit, file an issue and start a + discussion before proceeding. +* **DON'T** submit PRs that alter licensing related files. Commit Messages --------------- @@ -56,7 +103,8 @@ below. Fix #42 ``` -Also do your best to factor commits appropriately, not too large with unrelated things in the same commit, and not too small with the same small change applied N times in N different commits. +Also do your best to factor commits appropriately, not too large with unrelated things in the same commit, and not too +small with the same small change applied N times in N different commits. File Headers ------------ @@ -77,5 +125,6 @@ The following rules must be followed for PRs that include files from another pro Porting Files from Other Projects --------------------------------- -There are many good algorithms implemented in other languages that would benefit the .NET Core project. -The rules for porting an R file to C#, for example, are the same as would be used for copying the same file, as described above. +There are many good algorithms implemented in other languages that would benefit our project. +The rules for porting an R file to C#, for example, are the same as would be used for copying the same file, as +described above. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 000000000..693276569 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 QUT + + 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. \ No newline at end of file diff --git a/README.md b/README.md index 5b2c2c153..257d4defc 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,69 @@ # audio-analysis -The audio analysis source base for the QUT Bioacoustics Research Group +The source code for the QUT Ecoacoustics _AnalysisPrograms.exe_ program. -## Build status - -[![Build status](https://ci.appveyor.com/api/projects/status/ntf6vtuy5wnlww37/branch/master?svg=true)](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/branch/master) - -**NEW**: Weekly versions of AnalysisPrograms.exe are now built automatically at midnight Monday night. -You can get copies from the [Releases](https://github.com/QutBioacoustics/audio-analysis/releases) page. - -**NEW**: Per-commit builds can be found from the AppVeyor -[artifacts](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/build/artifacts) -page. - -## Licence +## Quick links -ALL RIGHTS ARE RESERVED. + - See the **[docs](./docs/README.md)** for instructions on + - Downloading AnalysisPrograms.exe + - Running the program + - Understanding concepts +- See the **[Issues list](https://github.com/QutEcoacoustics/audio-analysis)** for + - reporting bugs + - requesting new features +- See the **[Contributing guidelines](./CONTRIBUTING.md)** if you want to + - Compile the code yourself + - Make a contribution -THIS CODE BELONGS TO QUT. THIS CODE IS THE COPYRIGHT OF QUT. +## Description -INTELLECTUAL PROPERTY OF ALL CONCEPTS WITHIN THIS REPOSITORY REMAIN PROPERTY OF QUT WITH THE EXCEPTION OF STUDENT'S CODE. -IF STUDENTS ASSIGN THEIR INTELLECTUAL PROPERTY TO QUT THEN THOSE CONCEPTS ALSO BELONG TO QUT. -OTHERWISE, THE INTELLECTUAL PROPERTY OF CONCEPTS WRITTEN BY STUDENTS IN THIS REPOSITORY BELONGS TO THEM. +*QUT Ecoacoustics Analysis Programs* is a software package that can perform a suite of analyses on audio recordings of +the environment. Although the analyses are intended for long-duration recordings (1 – 24 hours), in fact they +can be performed on any audio file in a format supported by the software. Analysis Programs can: -YOU MAY NOT SHARE, USE, REPRODUCE, PUBLISH, OR OTHERWISE MODIFY ANY CONCEPT, CODE, OR ARTEFACT IN THIS REPOSITORY WITHOUT PERMISSION. -ANY CONTRIBUTIONS TO THIS REPOSITORY REMAIN PROPERTY OF QUT UNLESS OTHERWISE AGREED UPON. IF AN AGREEMENT IS MADE, THAT AGREEMENT MUST -BE INCLUDED IN EACH RELEVANT FILE. +- calculate of summary and spectral acoustic indices at variable resolutions +- produce long-duration, false-colour, multi-index spectrograms +- calculate critical statistics of annotations downloaded from an Acoustic Workbench +- run various acoustic event recognizers -WE RESERVE THE RIGHT TO CHANGE THE CONDITIONS OF THIS LICENSE AT ANY TIME, IN ANY WAY, AND APPLY THOSE CHANGES RETROACTIVELY. +All the analyses are performed by a single executable file, _AnalysisPrograms.exe_. -## Best Practices +## Citation -- Set the git `autocrlf` config setting. See for instructions. -- Avoid adding binary content to this repository - especially _RData_ files. -- NEVER commit if the code does not build -- Try to work on branches if your code negatively affects production code -- Write code in American English. Documentation may be written in Australian English. +Use this citation in all publications that use data or concepts from this code base is required: -## Daily routine +> Towsey, M., Truskinger, A., & Roe, P. (2017) Audio Analysis Software (Version 17.04.3813.0) \[Computer software\]. +> Brisbane: QUT Ecoacoustics Research Group, https://github.com/QutEcoacoustics/audio-analysis -- ALWAYS _Sync_ (or `git pull`) before you start work -- Do your work -- Add your files (Check the checkboxes or `git add`) - - ALWAYS check the files you add - often files you don't want to add are added automatically -- Commit the files in units of work (press the commit button or `git commit`). Always provide a descriptive message. -- ALWAYS _Sync_ (or `git push`) after you start work +Additionally, depending on the analysis that was run, extra work may be required to be cited. Any such additional +citations will printed in the console and in the log file. +## Build status -## Structure - -The `Acoustics` and `AudioAnalysis` folders contain the code and resources for -the audio analysis work. The `Extra Assemblies` folder contains `.dll` files -and other binary resources. - - -## Blobs - -We use [git-lfs](https://git-lfs.github.com/) to store BLOBs for testing audio -file converters. If you want to run the unit tests you need to have git-lfs -installed. +[![Build status](https://ci.appveyor.com/api/projects/status/ntf6vtuy5wnlww37/branch/master?svg=true)](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/branch/master) -Not all BLOBs are stored in git-lfs. So far only the audio files in -`Acoustics\Acoustics.Test\TestResources` have been added. +Weekly versions of AnalysisPrograms.exe are now built automatically at midnight Monday night. +You can get copies from the [Releases](https://github.com/QutBioacoustics/audio-analysis/releases) page. -## Required Software +Per-commit (the very latest) builds can be found from the AppVeyor +[artifacts](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/build/artifacts) +page. -### .Net Solutions +# License -- Visual Studio 2017 -- Resharper Ulitmate (Academic License) - - Install these plugins (_ReSharper_ menu > _Extension Manager_) - - ReSpeller Free -- [msysgit](https://git-for-windows.github.io/) +This project is very old. We've released the full history for the sake of maintainability and transparency. +Unfortunately this means all code before our open source release is not open sourced. -### R - -- R -- R Studio +In practice this should never be a problem. We never use our old code, except for historical purposes, and you never +should need to either. -### Matalab +## Newer code - All commits after [a275d0bc5744ba43096b43de2ef2aee32dc14c18](https://github.com/QutEcoacoustics/audio-analysis/commit/a275d0bc5744ba43096b43de2ef2aee32dc14c18) -- Matlab +All code after a275d0bc5744ba43096b43de2ef2aee32dc14c18 () are licensed under the +[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) -# Making a release +## Older code - 1. Pull latest changes to your local computer - 2. Make sure the repo is clean (no uncommitted changes) - 8. Open a prompt, `cd` to the git repo folder - 9. Run `. .\release.ps1` - 10. Profit :sparkles: :moneybag: :dollar: :heavy_dollar_sign: :sparkles: +All commits before a275d0bc5744ba43096b43de2ef2aee32dc14c18 () are not licensed under +an open source license. All rights and copyright are retained, however, the public has permission to view, link to, cite +the code on GitHub. \ No newline at end of file diff --git a/docs/README.MD b/docs/README.MD index cbcc00013..0e639ce77 100644 --- a/docs/README.MD +++ b/docs/README.MD @@ -1,7 +1,12 @@ # QUT Ecoacoustics: AnalysisPrograms.exe manual -*QUT Ecoacoustics Analysis Programs* is a software package to perform a suite of analyses on audio recordings of the environment. Although the analyses are intended for long-duration recordings (1 – 24 hours approx), in fact they can be performed on any audio file in a format supported by the software. Typically, you would not use the software to analyse recordings shorter than one minute. Currently the software performs: +*QUT Ecoacoustics Analysis Programs* is a software package that can perform a +suite of analyses on audio recordings of the environment. Although the analyses +are intended for long-duration recordings (1 – 24 hours approx), in fact they +can be performed on any audio file in a format supported by the software. +Typically, you would not use the software to analyse recordings shorter than one + minute. Currently the software performs: - calculation of summary and spectral acoustic indices at variable resolutions - produces long-duration, false-colour, multi-index spectrograms