source: ReferenceDesigns/w3_802.11/python/wlan_exp/log/util_sample_data.py

# -*- coding: utf-8 -*-
"""
------------------------------------------------------------------------------
Mango 802.11 Reference Design Experiments Framework - Sample Log Data Utilities
------------------------------------------------------------------------------
License:   Copyright 2019 Mango Communications, Inc. All rights reserved.
           Use and distribution subject to terms in LICENSE.txt
------------------------------------------------------------------------------

Provides sample data to use with the log examples.

"""

_SAMPLE_DATA_DIR = 'sample_data'

_FILES_TO_DL = [
    'ap_two_node_two_flow_capture.hdf5',
    'sta_two_node_two_flow_capture.hdf5',
    'ap_one_node_capture.hdf5',
    'np_rx_ofdm_entries.hdf5',
]

def get_sample_data_dir():
    import os

    # Find wlan_exp.log directory using this module's location as a reference
    sd_parent = os.path.split(os.path.abspath(__file__))[0]

    # Construct the full path to the sample_data directory
    sd_path = os.path.join(sd_parent, _SAMPLE_DATA_DIR)

    # Only return successfully if the directory already exists
    if(os.path.isdir(sd_path)):
        return sd_path
    else:
        raise Exception("ERROR: Sample data directory not found in wlan_exp.log package!\n")

# End def



def download_sample_data():
    import os, sys
    import wlan_exp.version as ver

    sample_data_dir = get_sample_data_dir()

    url_root = 'http://warpproject.org/dl/refdes/802.11/sample_data/{}.{}.{}/'.format(ver.WLAN_EXP_MAJOR, ver.WLAN_EXP_MINOR, ver.WLAN_EXP_REVISION)

    try:
        import requests
    except ImportError:
        print("\nERROR: auto download requires the Python requests package!\n")
        print(" Please download sample data files manually from:")
        print("   http://warpproject.org/w/802.11/wlan_exp/sample_data\n")
        print(" Sample data files should be saved in local folder:")
        print("   {0}".format(os.path.normpath(sample_data_dir)))
        return



    print("Downloading 802.11 Reference Design sample data to local directory:")
    print(" From: {0}".format(url_root))
    print(" To:   {0}\n".format(os.path.normpath(sample_data_dir)))

    # Progress indicator based on great StackOverflow posts:
    #   http://stackoverflow.com/questions/15644964/python-progress-bar-and-downloads

    for fn in _FILES_TO_DL:
        fn_full = os.path.join(sample_data_dir, fn)

        if(os.path.isfile(fn_full)):
            print("\rERROR: Local file {0} already exists".format(fn_full))
        else:
            r = requests.get(url_root + fn, stream=True)
            len_total = r.headers.get('content-length')

            if(r.status_code != 200):
                print("\rERROR: Failed to download {0}; HTTP status {1}".format(url_root + fn, r.status_code))
            else:
                with open(fn_full, "wb") as f:
                    if len_total is None: # no content length header
                        f.write(r.content)
                    else:
                        print("Downloading {0} ({1:5.2f} MB)".format(fn, float(len_total)/2**20))
                        len_done = 0
                        len_total = int(len_total)
                        for data_chunk in r.iter_content(chunk_size=2**17):
                            len_done += len(data_chunk)
                            f.write(data_chunk)
                            done = int(70 * len_done / len_total)
                            sys.stdout.write("\r[%s%s]" % ('=' * done, ' ' * (70-done)) )
                            sys.stdout.flush()
                        print('\r')

# End def



def get_sample_data_file(filename):
    import os

    sample_data_dir = get_sample_data_dir()

    file_path = os.path.join(sample_data_dir, filename)

    if(os.path.isfile(file_path)):
        return file_path
    else:
        msg  = "ERROR: sample data file {0} not found in local sample data directory!\n".format(filename)
        msg += "  Please ensure that sample data has been downloaded.  Instructions at:\n"
        msg += "      https://warpproject.org/trac/wiki/802.11/wlan_exp/sample_data"
        raise IOError(msg)

# End def