PWSpy_gui

A collection of GUIs providing users with easy access to the pwspy library. The main application provided by this package is the PWS Analysis application. You can find a tutorial on using PWS Analysis here

Installation

The first step in installation is to install Anaconda on your computer. Once installation is completed you will be able to install PWSpy_gui by typing commands into the terminal. On Mac and Linux you can use the standard terminal, on Windows you should open "Anaconda Prompt". It is advisable to install PWSpy_gui into its own "environment" to avoid dependency conflicts. Create a new environment with the command: conda create -n {environmentName} python=3.8. You can then make the new environment active in your terminal with conda activate {environmentName}.

More information here.

Installing from Anaconda Cloud (recommended)

PWSpy_gui is stored online on the "backmanlab" Anaconda Cloud channel. It can be installed from Conda with the command conda install -c conda-forge -c backmanlab pwspy_gui

Installing Manually

If you have the built package (.tar.gz file) then you can install the package by pointing conda install to it. Install the package with conda install -c file:///{tarGzFileDestination} -c conda-forge pwspy_gui.

First time startup

While the pwspy_gui package has many facets one of the major components is the "PWS Analysis App" GUI which is used to analyze PWS data. There are multiple ways that you can run this application:

1. On Windows a PWS Analysis shortcut should appear in your Start Menu under the Anaconda category

2. Type PWSAnalysis into the command prompt for the Conda environment that pwspy_gui is installed in.

3. In Anaconda-Navigator an app named pwspy_gui should appear. On Windows a program called PWSAnalysis should appear in the start menu.

The first time you run the GUI on a computer you will need to sign into the Google Drive database where calibration data is stored.

Building from source and distributing

Setting up your computer to build the source code.

First you will need the Conda package manager. If you have installed Anaconda then Conda is included. On Windows you will need to use the Anaconda Prompt rather than the default Windows Command Prompt. In addition you will need:

• conda-build
• anaconda-client
• setuptools_scm

These can be installed with the following command conda install conda-build anaconda-client gitpython

Automatic Method (Recommended):

Use the python in your base anaconda environment to run python installScripts\build.py. The output will default to buildscripts/conda/build. You can optionally provide a custom output path as the first argument to the build.py script. There will be many files here but the most important one is build/noarch/pwspy_gui_xxxxxxxxxx.tar.gz. This will update the module version in the _version file and run the conda-build and deploy steps. The version number can be understood as a.b.c.d-xyz where a.b.c are numbers set manually with a Git Tag, d is the number of commits since a.b.c was tagged, xyz is the short sha hash for the git commit.

Uploading a newly built version of the package to Anaconda Cloud

The lab has a Cloud account at anaconda.org. The username is backmanlab and the password is UNKNOWN!!!! (do not put the password here, this git repository is publically available, we prefer not to get hacked). You can upload the package to the lab's Anaconda Cloud account using anaconda login to log into the account and then with anaconda upload build/noarch/pwspy_gui_xxxxxxxxxx.tar.gz