environment.md

 # Software Environments
 
-This page detail the various software environments available for use in CDC, where the primary aim is to support development using GNU Radio. It describes how to access these environments outside of EDS12 and how to install them on your personal computer should you so desire. Please do not hesitate to contact me if you encounter any environment related problems.
+This page details the various software environments available for use in CDC,
+where the primary aim is to support development using GNU Radio. It describes
+how to access these environments outside of EDS12 and how to install them on
+your personal computer should you so desire.
+
+Please don't hesitate to contact me if you encounter any environment related
+issues.
 
 ## FEIT GPU Desktop
 
-The same FEIT Desktop used on the lab computers in EDS12 is accessible to you outside of workshop through myUniApps. To access the environment:
+The same FEIT Desktop used on the lab computers in EDS12 is available to you
+outside of workshop through myUniApps. To access the environment:
 
-1. Open a browser and navigate to [https://unimelb.cloud.com](https://unimelb.cloud.com)
+1. Open a browser and navigate to
+[https://unimelb.cloud.com](https://unimelb.cloud.com)
 2. Login with your university credentials
-3. If you wish, install Citrix Workspace on your personal computer by clicking *Detect Workspace*, otherwise click *Use web browser*
-4. Navigate to *Desktops >> All Desktops*
+3. If you wish, install Citrix Workspace on your personal computer by
+clicking *Detect Workspace*, otherwise click *Use web browser*
+4. Navigate to *Desktops > All Desktops*
 5. Open a session by selecting *FEIT GPU Desktop*
 6. Login to Windows using your university credentials
 
-Obviously, you will not be able to interface with the SDR hardware when accessing the remote desktop, but you can still perform much of your software development.
+Obviously, you will not be able to interface with the SDR hardware when
+accessing the remote desktop, but you can still perform much of your software
+development and debugging.
 
-> **WARNING:** The FEIT GPU Desktop is **non-persistent** – locally saved data may be lost when you log out. Make sure to save any files you wish to keep to another location, e.g., your OneDrive account.
+> **WARNING:** The FEIT GPU Desktop is **non-persistent** – locally saved data
+> may be lost when you log out. Make sure to save any files you wish to keep to
+> another location, e.g., your OneDrive account.
 
 ### Ubuntu Linux VM
 
-The main environment we will be using is an Ubuntu Linux virtual machine (VM) that we can use to run GNU Radio. This option will allow more stable usage of the Nuand bladeRF SDR hardware that will be the focus of the design project. Additionally, extending GNU Radio functionality through the creation and compilation of C++ signal processing blocks is straightforward under Linux.
+The main environment we will be using is an Ubuntu Linux virtual machine (VM) in
+which we can run GNU Radio. This option will allow stable usage of the Nuand
+bladeRF SDR hardware that will be the focus of the design project. Additionally,
+extending GNU Radio functionality through the creation and compilation of C++
+signal processing blocks is straightforward under Linux.
 
 On the FEIT GPU Desktop, the Ubuntu Linux VM can be accessed as follows.
 
@@ -30,7 +47,9 @@ On the FEIT GPU Desktop, the Ubuntu Linux VM can be accessed as follows.
 username: cdc\
 password: unimelb
 
-To open Python or GRC, first open a bash shell by clicking on the Terminal icon in the dock: ![terminal icon](images/terminal.png). The Python interpreter can then be launched at the command line.
+To open Python or GRC, first open a bash shell by clicking on the Terminal icon
+in the dock: ![terminal icon](images/terminal.png). The Python interpreter can
+then be launched at the command line.
 ```
 $ python3
 ```
@@ -41,7 +60,9 @@ $ gnuradio-companion
 
 ## Anaconda
 
-Anaconda is a distribution of the Python and R programming languages available for Windows, macOS, and Linux. Both Python and GNU Radio can be accessed on the Windows FEIT GPU Desktop through an Anaconda environment configured for CDC.
+Anaconda is a distribution of the Python and R programming languages available
+for Windows, macOS, and Linux. Both Python and GNU Radio can be accessed on the
+Windows FEIT GPU Desktop through an Anaconda environment configured for CDC.
 
 1. Navigate to *Start Menu > Ananconda3 (64-bit) > Anaconda Prompt (Anaconda3)*
 2. At the resulting command prompt, activate the ELEN90089 conda environment
@@ -59,31 +80,48 @@ or GRC
 
 ### MATLAB / Simulink
 
-Support packages for accessing both the Nuand bladeRF and the Ettus USRP have been installed should you want to access these devices in MATLAB and/or Simulink. Make sure to launch **MATLAB R2018b** and not Matlab R2020b. See the following pages for documentation on how to use these SDR devices in MATLAB/Simulink.
+Support packages for accessing both the Nuand bladeRF and the Ettus USRP have
+been installed should you want to access these devices in MATLAB and/or
+Simulink. Make sure to launch **MATLAB R2018b** and not Matlab R2020b. See the
+following pages for documentation on how to use these SDR devices in
+MATLAB/Simulink.
 
 - [Communications Toolbox Support Package for BladeRF 2.0](https://www.mathworks.com/matlabcentral/fileexchange/74591-communications-toolbox-support-package-for-bladerf-2-0)
 - [Communications Toolbox Support Package for USRP Radio](https://www.mathworks.com/help/supportpkg/usrpradio/)
 
 ## Installation on Your Personal Computer
 
-The following details how to install these environments supporting GNU Radio on your personal computer .
+The following details how to install these environments supporting GNU Radio on
+your personal computer .
 
-> **Important Note:** Please be advised installation on a personal computer is optional and you install at your own risk. I may not be able to help resolve any issues you encounter!
+> **Important Note:** Please be advised installation on a personal computer is
+> optional and you install at your own risk. I may not be able to help resolve
+> any issues you encounter!
 
 ### Ubuntu VM
 
-The Ubuntu VM used in workshop can be run on your personal computer by installing VirtualBox. VirtualBox is a free and open-source virtualization tool supported on Windows, macOS, and Linux. To set up your computer to run the ELEN90089 Ubuntu VM:
-
-1. Download and install the latest version of [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
-2. To use the SDR hardware (bladeRF 2.0 or USRP B210) with your personal computer, add USB 3.0 support by installing the [VirtualBox Extensions Pack](https://www.virtualbox.org/wiki/Downloads)
-- Download the ELEN90089 environment files (Version X - uploaded DD MMM YYYY):\
-[TBD]() (X KB)\
+The Ubuntu VM used in workshop can be run on your personal computer by
+installing VirtualBox. VirtualBox is a free and open-source virtualization tool
+supported on Windows, macOS, and Linux. To set up your computer to run the
+ELEN90089 Ubuntu VM:
+
+1. Download and install the latest version of
+[VirtualBox](https://www.virtualbox.org/wiki/Downloads)
+2. To use the SDR hardware (bladeRF 2.0 or USRP B210) with your personal
+computer, add USB 3.0 support by installing the
+[VirtualBox Extensions Pack](https://www.virtualbox.org/wiki/Downloads)
+3. Download the ELEN90089 environment files (Ver X - uploaded DD MMM YYYY):  
+[TBD]() (X KB)  
 [TBD]() (X GB)
-- Doubleclick on the `.vbox` configuration file to import the VM into VirtualBox.
+4. Doubleclick on the `.vbox` configuration file to import the VM into
+VirtualBox.
 
-> **Note:** The `.vdi` file is large (X GB!!!). Make sure you are on a good, unmetered internet connection before downloading.
+> **Note:** The `.vdi` file is large (X GB!!!). Make sure you are on a good,
+> unmetered internet connection before downloading.
 
-The `.vbox` configuration file provided has minimal system settings. Depending on the resources available on your personal computer you may want to increase these for better performance.
+The `.vbox` configuration file provided has minimal system settings. Depending
+on the resources available on your personal computer you may want to increase
+these for better performance.
 
 > Settings > System > Motherboards > Base Memory
 
@@ -91,18 +129,28 @@ The `.vbox` configuration file provided has minimal system settings. Depending o
 
 ### Conda
 
-Another option for using GNU Radio in the workshops is through the Anaconda  environment on the FEIT GPU Desktop image. Should you wish to install the same environment on your Windows, macOS, or Linux personal computer, you can follow these instructions. First decide whether you want to install Anaconda or its lightweight version Miniconda. Anaconda has a graphical environment management tool and automatically downloads 250+ packages. Miniconda is command line only and will download packages as needed for your environments.
+Another option for using GNU Radio in the workshops is through the Anaconda
+environment on the FEIT GPU Desktop image. Should you wish to install the same
+environment on your Windows, macOS, or Linux personal computer, you can follow
+these instructions. First decide whether you want to install Anaconda or its
+lightweight version Miniconda. Anaconda has a graphical environment management
+tool and automatically downloads 250+ packages. Miniconda is command line only
+and will download packages as needed for your environments, thus saving space.
 
 - [Installing Anaconda](https://docs.anaconda.com/anaconda/install/index.html#)
 - [Installing Miniconda](https://docs.conda.io/projects/continuumio-conda/en/latest/user-guide/install/index.html)
 
-Next, download the following YAML environment file specifying the packages in the ELEN90089 conda environment:
+Next, download the following YAML environment file specifying the packages in
+the ELEN90089 conda environment:
 
-- [elen90089_2021_03_14.yml](files/elen90089_2021_03_14.yml) (*uploaded 26 Feb 2022*)
+- [elen90089_2021_03_14.yml](files/elen90089_2021_03_14.yml)
+(*uploaded 26 Feb 2022*)
 
-> **Note:** This configuration file may be updated over the semester as new package requirements are identified.
+> **Note:** This configuration file may be updated over the semester as new
+> package requirements are identified.
 
-Start a conda terminal or command prompt and create the ELEN90089 environment using the downloaded configuration file.
+Start a conda terminal or command prompt and create the ELEN90089 environment
+using the downloaded configuration file.
 ```
 > conda env create -f <ELEN90089 YML file>
 ```