Open Source Checklist

[atruskie]

We intend for this project to be released as an open source project.
There are a few things we have to complete before this becomes a reality:

• Basic approval
  • ✔️ Paul has said we can do this
• Intellectual property
  • Clear open sourcing with QUT Bluebox
  • Check IP of any student code
  • Choose an open source lisence
    • Dual licence - code before open source commit should have a restricted licence
• Code removal and cleanup
  • Remove dev methods (See Intention to deprecate: Dev() method will no longer be supported #134 )
  • Do a full backup of the repository
  • Fix as many warnings as possible
  • Remove uneeded projects
    • Dong.Felt
    • QutBioacoustics.Xie
    • AudioBrowser
    • FSharp.FELT.*
  • Remove old/dead code
  • Clear Sandpit.cs
  • Search for any remove any reference to absolute paths (e.g. C:\..)
  • Remove most of the MATLAB code (keep stuff for AED, remove anything done by students)
  • Remove all RCode
  • Investigate reducing size of repo
    • git-filter branch Extra-assemblies
  • Reorganize folders (src, test etc...)
  • Fix old dependencies
    • Dynamic yaml (See Removing Dynamic configuration #119)
    • PowerArgs (See Find a simpler, more flexible CLI argument parser #145)
• Other
  • Add a scripts folder that has demos of common scripts
  • Add/enhance our basic documentation - See Improve AP.exe documentation #130
  • Add a standard citation for the software (in README.md and printed in logs)
  • [ ] Add analysis specific citations See Add command/analysis specific citations #149
  • Update GitHub issue template and contributing guide
  • [ ] Add app metrics Add app metrics #150

[atruskie]

From @towsey (https://github.com/QutBioacoustics/Ecoacoustics/issues/197):

Removal of obsolete classes from the AudioAnalysis solution.

The following classes have the potential to be removed from AnalysisPrograms. There may be unintended consequences that require, for example, the moving of single methods to another class etc.
There may be other classes that could be removed - I have only indicated those which I have worked on.

• CanetoadOld_OBSOLETE.cs
• Crow.cs
• Dong.Felt.Main.cs
• DrawEasyImage.cs
• EPR.cs
• FeltTemplate_Create.cs
• FeltTemplate_Edit.cs
• FeltTemplates_Use.cs
• FrogRibit_OBSOLETE.cs
• Frogs_OBSOLETE.cs
• GratingDetection_OBSOLETE.cs
• HerveGlotinCollaboration.cs
• Human1.cs
• LewinsRail3OBSOLETE.cs
• LimnodynastesConvex_OBSOLETE.cs
• LitoriaFallax_OBSOLETE.cs
• PlanesTrainsAndAutomobiles.cs
• Rain_OBSOLETE.cs
• RheobatrachusSilus.cs
• SPR_OBSOLETE.cs
• SURFAnalysis.cs
• XiesAnalysis.cs

Some classes in other folders that can likely be removed.

• /Recognizers/CriniaTinnula_OBSOLETE.cs
• /AnalysisConfigFiles/Towsey.MultiAnalyser.OBSOLETE.yml
• /AudioAnalysisTools/BirdClefExperiment1.cs
• /AudioAnalysisTools/FrommoltProject.cs
• /AudioAnalysisTools/SURFFeatures.cs
• /AudioAnalysisTools/DSP/AudioSegmentationOBSOLETE.cs
• /AudioAnalysis/Dong.Felt
• /AudioAnalysis/TowseyLibrary/Gratings.cs