Adding comments on use of scripts.

developer_tools/check_pip_packages.sh

@@ -1,5 +1,16 @@
 #!/bin/bash
 
+# This script tests that the 3.7 and 3.8 wheels built in directory dist
+# are installable. It will not work if there is more than one
+# version of the wheel for a python version (including for other os's)
+# It is designed to be run after (or similar):
+# rm -Rf dist; ./developer_tools/make_pip_packages.sh
+# It will install raven_framework in the python37_pip and python38_pip
+# conda environments
+# It requires that .ravenrc has a working CONDA_DEFS statement.
+# To run from the raven directory:
+# ./developer_tools/check_pip_packages.sh
+
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 RAVEN_DIR=`dirname $SCRIPT_DIR`
 
@@ -12,7 +23,8 @@ cd $RAVEN_DIR
 ls -l dist
 
 #The following works to install from the dist directory, but also can install
-# from pypi so doesn't fail if not created in dist, so can't be used
+# from pypi so doesn't fail if wheels not created in dist, so can't be used
+# for automated testing
 #python -m pip install -f file://${RAVEN_DIR}/dist raven_framework || exit -1
 
 echo

developer_tools/make_pip_packages.sh

@@ -1,5 +1,16 @@
 #!/bin/bash
 
+# This script builds 3.7 and 3.8 wheels and puts them in the dist directory
+# It will create python37_pip and python38_pip conda environments
+# and use them for building pip packages.
+# It requires that .ravenrc has a working CONDA_DEFS statement.
+# To run from the raven directory:
+# ./developer_tools/make_pip_packages.sh
+# this can be run on windows, mac and linux, and then the wheels for
+# each operating system can be collected, tested and uploaded to pypi
+# The main pip build instructions are in the setup.py file.
+
+
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 RAVEN_DIR=`dirname $SCRIPT_DIR`