-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged paltforms and installing instructions, also simplified the isntructions [skip_ci]
- Loading branch information
Showing
3 changed files
with
114 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,136 @@ | ||
| # Installing | ||
|
|
||
| [](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/branch/master) | ||
|
|
||
|
|
||
| ## General | ||
|
|
||
| 1. Choose what version of _AP.exe_ that you want | ||
| - Stable: Well tested code, used on production servers, usually months old | ||
| - Weekly: Automatic build based off the master branch. | ||
| - Has many more features and many more bug fixes | ||
| - Has many more bugs | ||
| - Continuous: Builds that are done by the continuous integration system | ||
| - Bleeding edge, always up to date | ||
| - Bleeding edge, very likely will break | ||
| 1. Download a package | ||
| - Click on the appropriate link | ||
| - [Stable](https://github.com/QutEcoacoustics/audio-analysis/releases/latest) | ||
| - [Weekly](https://github.com/QutEcoacoustics/audio-analysis/releases) | ||
| - [Continuous](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/build/artifacts) | ||
| - Download the _Release_ version - it will be a ZIP file that starts with _Release_ | ||
| 1. Extract the contents to a directory on your computer | ||
| - It can be installed in any directory | ||
| - We typically extract to a directory named `C:\Temp\AP` | ||
| 1. [Optionally] Add the directory to your system's `PATH` environment variable | ||
| - This makes it easier to type _AP.exe_ commands | ||
| ## Beginner Tutorial | ||
|
|
||
| When you've downloaded and extracted the program you can check the install by | ||
| running: | ||
| If you're new to using _AP.exe_ we recommend following the isntructions | ||
| in the <https://research.ecosounds.org/tutorials/ap/practical> practical | ||
| to setup and install _AP.exe_ | ||
|
|
||
| ## Supported Platforms | ||
|
|
||
| - Any Windows computer with v4.6.2 of the .NET Framework installed. | ||
| - Mac OS X 10.9 and later. | ||
| - Linux | ||
| - Ubuntu 16.04 (used in production) | ||
| - Debian 9 (out Docker image is based on Debian) | ||
| - Raspian (not tested) | ||
| - Docker: <https://hub.docker.com/r/qutecoacoustics/audio-analysis/> | ||
| - Singularity (coming soon) | ||
|
|
||
| ``` | ||
| AnalysisPrograms.exe CheckEnvironment | ||
| ``` | ||
|
|
||
| ## MacOSX | ||
| ## Prerequisites | ||
|
|
||
| ### Windows | ||
|
|
||
| - The .NET Framework v4.6.2 (Installed by default on most Windows computers) | ||
|
|
||
| ### MacOSX | ||
|
|
||
| The following additional dependencies are required for MaxOSX machines: | ||
|
|
||
| - mono (version 5.5 or greater) | ||
| - [Mono](https://www.mono-project.com/download/stable/#download-mac) (version 5.5 or greater) | ||
| - [Optional] [Powershell](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-macos?view=powershell-6) | ||
|
|
||
| Note all AP.exe commands must be prefixed with `mono ` to be used on MacOSX. | ||
|
|
||
| ``` | ||
| $ mono AnalysisPrograms.exe CheckEnvironment | ||
| ``` | ||
|
|
||
|
|
||
| ## Unix | ||
| ### Unix | ||
|
|
||
| The following additional dependencies are required for Unix machines: | ||
|
|
||
| - mono (version 5.5 or greater) | ||
| - [Mono]( https://www.mono-project.com/download/stable/#download-lin) (version 5.5 or greater) | ||
| - ffmpeg | ||
| - wavpack | ||
| - libsox-fmt-all | ||
| - sox | ||
| - shntool | ||
| - mp3splt | ||
| - libav-tools | ||
| - [Optional] [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-linux?view=powershell-6) | ||
|
|
||
| Note all AP.exe commands must be prefixed with `mono ` to be used on Linux. | ||
|
|
||
| ``` | ||
| $ mono AnalysisPrograms.exe CheckEnvironment | ||
| ``` | ||
|
|
||
| ## Automatic install | ||
|
|
||
| The prerequisites must be installed first. | ||
|
|
||
| ### Windows | ||
|
|
||
| Run the following command in an elevated (_Run as Administrator_) prompt: | ||
|
|
||
| ``` | ||
| PowerShell -NoProfile -ExecutionPolicy Bypass -Command "$t = \"$env:Temp\download_ap.ps1\"; (New-Object System.Net.WebClient).DownloadFile('https://raw.githubusercontent.com/QutEcoacoustics/audio-analysis/master/build/download_ap.ps1', $t); & $t; rm $t" | ||
| ``` | ||
|
|
||
| ### MacOSX and Linux | ||
|
|
||
| Only supported if you installed PowerShell, otherwise see the _Manual Install_ | ||
| instructions below. | ||
|
|
||
| Run the following in _Terminal_: | ||
|
|
||
| ``` | ||
| sudo pwsh -NoProfile -ExecutionPolicy Bypass -Command "\$t = \"\$env:Temp/download_ap.ps1\"; (New-Object System.Net.WebClient).DownloadFile('https://raw.githubusercontent.com/QutEcoacoustics/audio-analysis/master/build/download_ap.ps1', \$t); & \$t; rm \$t" | ||
| ``` | ||
|
|
||
| **NOTE**: Please inspect | ||
| https://github.com/QutEcoacoustics/audio-analysis/blob/master/build/download_ap.ps1 | ||
| prior to running ensure safety. We already know it's safe, but you should verify | ||
| the security and contents of any script from the internet you are not familiar | ||
| with. All of these scripts download a remote PowerShell script and execute it on | ||
| your machine. | ||
|
|
||
| ## Packages | ||
|
|
||
| There are three packages AP.exe: | ||
|
|
||
| 1. The **Stable** release is well tested used by QUT Ecoacoustics on our servers | ||
| and is usually a few months old | ||
| 2. The **Weekly** release is automatically built every Monday. It has more | ||
| features and bug fixes than the stable release but it also could have more | ||
| bugs. | ||
| 3. The **Continuous** package is created every time there is a change to our | ||
| code. It is the bleeding edge: always up to date but conversely the most | ||
| likely to have bugs. | ||
|
|
||
| You should use the **Stable** release unless there is a specific feature or bug | ||
| you need. | ||
|
|
||
| ## Manual Install | ||
|
|
||
| The prerequisites must be installed first. | ||
|
|
||
| 1. Download the _Release_ Zip file from one of these links: | ||
| - [Stable](https://github.com/QutEcoacoustics/audio-analysis/releases/latest) | ||
| - [Weekly](https://github.com/QutEcoacoustics/audio-analysis/releases) | ||
| - [Continuous](https://ci.appveyor.com/project/QUTEcoacousticsResearchGroup/audio-analysis/build/artifacts) | ||
| 1. Extract the contents to a directory on your computer | ||
| - It can be installed in any directory | ||
| - We typically extract to a directory named `C:\AP` or `/AP` on Linux | ||
| 1. [Optionally] Add the directory to your system's `PATH` environment variable. | ||
| This makes it easier to type _AP.exe_ commands | ||
| 1. Check the install by running: | ||
|
|
||
| ``` | ||
| C:\AP\AnalysisPrograms.exe CheckEnvironment | ||
| ``` | ||
| Or on MacOSX and Linux | ||
| ``` | ||
| mono /AP/AnalysisPrograms.exe CheckEnvironment | ||
| ``` | ||
| ## Coming soon: Docker | ||
| We have a `Dockerfile` that theoretically works (BETA warning). See the | ||
| `build` directory to find it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +0,0 @@ | ||
| # Supported Execution Platforms | ||
|
|
||
| ## Platform | ||
|
|
||
| ### Windows | ||
|
|
||
| The _AP.exe_ binary will run on any Windows computer with v4.6.2 of the .NET | ||
| Framework installed. | ||
| Practically, it means that these variants are supported: | ||
|
|
||
| - Client SKUs (stock keeping unit) | ||
| - ✓ 10 Anniversary Update | ||
| - \+ 10 November Update | ||
| - \+ 10 | ||
| - \+ 8.1 | ||
| - \+ 7 | ||
| - Server SKUs | ||
| - ✓ 2016 | ||
| - \+ 2012 R2 | ||
| - \+ 2012 | ||
| - \+ 2008 R2 SP1 | ||
|
|
||
| The ticks (✓) mean the framework can be installed, the plusses (+) indicate | ||
| the framework should be installed. | ||
| The above was taken from <https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/versions-and-dependencies> | ||
|
|
||
| ### Unix | ||
|
|
||
| To run _AP.exe_ on Unix systems, the Mono runtime needs to be installed. | ||
| We require **Mono Version 5.5** or greater to be installed. | ||
|
|
||
| We support the following distributions: | ||
|
|
||
| - Ubuntu 16.04 (used in production) | ||
| - Debian 9 (~~not tested~~ our upcoming Docker image is based on Debian) | ||
| - Raspian (not tested) | ||
|
|
||
| To run a .NET Framework binary with Mono, simply prefix the command you would | ||
| use on Windows with the `mono` keyword. | ||
| For example, in Windows: | ||
|
|
||
| ```cmd | ||
| > AnalysisPrograms.exe list | ||
| ``` | ||
|
|
||
| In Linux: | ||
|
|
||
| ``` | ||
| $ mono AnalysisPrograms.exe list | ||
| ``` | ||
|
|
||
| ### MacOSX | ||
|
|
||
| We support Mac OS X 10.9 and later. | ||
|
|
||
| Should the same as the Unix requirements, however, we have limited exeprience | ||
| running on MacOSX systems. | ||
|
|
||
| We'd like to hear from you if you do try! | ||