powersimdata.utility package

Subpackages

• powersimdata.utility.templates package
  • Module contents
• powersimdata.utility.tests package
  • Submodules
  • powersimdata.utility.tests.test_distance module
    • test_angular_distance()
    • test_find_closest_neighbor()
    • test_ll2uv()
  • powersimdata.utility.tests.test_helpers module
    • test_cache_key_distinct_types()
    • test_cache_key_valid_types()
    • test_mem_cache_get_returns_copy()
    • test_mem_cache_put_dict()
    • test_mem_cache_put_version_never_changes()
    • test_no_collision()
    • test_print_is_disabled()
  • Module contents

Submodules

powersimdata.utility.config module

class powersimdata.utility.config.Config

Bases: object

Base class for configuration data. It should contain all expected keys, defaulting to None when not universally applicable.

BACKUP_DATA_ROOT_DIR = None

DATA_ROOT_DIR = '/mnt/bes/pcm'

ENGINE_DIR = None

EXECUTE_DIR = 'tmp'

INPUT_DIR = ('data', 'input')

LOCAL_DIR = '/root/ScenarioData/'

MODEL_DIR = None

OUTPUT_DIR = ('data', 'output')

SERVER_ADDRESS = None

SERVER_SSH_PORT = None

class powersimdata.utility.config.ContainerConfig

Bases: Config

Values specific to containerized environment

SERVER_ADDRESS = 'reisejl'

class powersimdata.utility.config.DeploymentMode

Bases: object

Constants representing the type of installation being used

CONFIG_MAP = {'CONTAINER': <class 'powersimdata.utility.config.ContainerConfig'>, 'LOCAL': <class 'powersimdata.utility.config.LocalConfig'>, 'SERVER': <class 'powersimdata.utility.config.ServerConfig'>}

Container = 'CONTAINER'

Local = 'LOCAL'

Server = 'SERVER'

class powersimdata.utility.config.LocalConfig

Bases: Config

Values specific to native installation

DATA_ROOT_DIR = '/root/ScenarioData/'

ENGINE_DIR = None

initialize()

Create data directory with blank templates

class powersimdata.utility.config.ServerConfig

Bases: Config

Values specific to internal client/server usage

MODEL_DIR = '/home/bes/pcm'

SERVER_ADDRESS = 'becompute01.gatesventures.com'

SERVER_SSH_PORT = 22

powersimdata.utility.config.get_config()

Get a config instance based on the DEPLOYMENT_MODE environment variable

Returns:

(powersimdata.utility.config.Config) – a config instance

powersimdata.utility.config.get_deployment_mode()

Get the deployment mode used to determine various configuration values

Returns:

(str) – the deployment mode

powersimdata.utility.distance module

powersimdata.utility.distance.angular_distance(uv1, uv2)

Calculate the angular distance between two vectors.

Parameters:

• uv1 (list) – 3-components vector as returned by ll2uv().

• uv2 (list) – 3-components vector as returned by ll2uv().

Returns:

(float) – angle (in degrees).

powersimdata.utility.distance.find_closest_neighbor(point, neighbors)

Locates the closest neighbor.

Parameters:

• point (tuple) – (lon, lat) in degrees.

• neighbors (list) – each element of the list are the (lon, lat) of potential neighbor.

Returns:

(int) – id of the closest neighbor

powersimdata.utility.distance.great_circle_distance(x)

Calculates distance between two sites.

Parameters:

x (pandas.dataFrame) – start and end point coordinates of branches.

Returns:

(float) – length of branch (in km.).

powersimdata.utility.distance.haversine(point1, point2)

Given two lat/long pairs, return distance in miles.

Parameters:

• point1 (tuple) – first point, (lat, long) in degrees.

• point2 (tuple) – second point, (lat, long) in degrees.

Returns:

(float) – distance in miles.

powersimdata.utility.distance.ll2uv(lon, lat)

Convert (longitude, latitude) to unit vector.

Parameters:

• lon (float) – longitude of the site (in deg.) measured eastward from Greenwich, UK.

• lat (float) – latitude of the site (in deg.). Equator is the zero point.

Returns:

(list) – 3-components (x,y,z) unit vector.

powersimdata.utility.helpers module

class powersimdata.utility.helpers.CacheKeyBuilder(*args, **kwargs)

Bases: object

Helper class to generate cache keys

Parameters:

args – variable length arguments from which to build a key

build()

Combine args into a tuple, preserving the structure of each element.

Returns:

(tuple) – container which can be used as a cache key

class powersimdata.utility.helpers.MemoryCache

Bases: object

Wrapper around a dict object that exposes a cache interface. Users should create a separate instance for each distinct use case.

get(key)

Retrieve the value associated with key if it exists.

Parameters:

key (tuple) – the cache key

Returns:

(Any or NoneType) – the cached value if found, or None

list_keys()

Return and print the current cache keys.

Returns:

(list) – the list of cache keys

put(key, obj)

Add or set the value for the given key.

Parameters:

• key (tuple) – a tuple used to lookup the cached value

• obj (Any) – the object to cache

class powersimdata.utility.helpers.PrintManager

Bases: object

Manages print messages.

static block_print()

Suppresses print

enable_print()

Enables print

powersimdata.utility.helpers.cache_key(*args, **kwargs)

Creates a cache key from the given args. The user should ensure that the range of inputs will not result in key collisions.

Parameters:

args – variable length argument list

Returns:

(tuple) – a tuple containing the input in heirarchical structure

powersimdata.utility.server_setup module

powersimdata.utility.server_setup.get_blob_credential()

powersimdata.utility.server_setup.get_server_user()

Returns the first username found using the following sources:

• BE_SERVER_USER environment variable

• powersimdata/utility/.server_user

• username of the active login.

Returns:

(str) – user name to be used to log into server.

Module contents