def test_from_scratch_sets(manage_rundir):
outdir = os.path.join(run_dir, 'from_scratch_sets')
if not os.path.exists(outdir):
os.mkdir(outdir)
with gdxpds.gdx.GdxFile() as gdx:
gdx.append(
gdxpds.gdx.GdxSymbol('my_set',
gdxpds.gdx.GamsDataType.Set,
dims=['u']))
data = pds.DataFrame([['u' + str(i)] for i in range(1, 11)])
data['Value'] = True
gdx[-1].dataframe = data
assert isinstance(
gdx[-1].dataframe[gdx[-1].dataframe.columns[-1]].values[0], c_bool)
gdx.append(
gdxpds.gdx.GdxSymbol('my_other_set',
gdxpds.gdx.GamsDataType.Set,
dims=['u']))
data = pds.DataFrame([['u' + str(i)] for i in range(1, 11)],
columns=['u'])
data['Value'] = True
gdx[-1].dataframe = gdx[-1].dataframe.append(data)
gdx.write(os.path.join(outdir, 'my_sets.gdx'))
with gdxpds.gdx.GdxFile(lazy_load=False) as gdx:
gdx.read(os.path.join(outdir, 'my_sets.gdx'))
for sym in gdx:
assert sym.num_dims == 1
assert sym.dims[0] == 'u'
assert sym.data_type == gdxpds.gdx.GamsDataType.Set
assert sym.num_records == 10
assert isinstance(
sym.dataframe[sym.dataframe.columns[-1]].values[0], c_bool)
def test_parameter_with_nulls(manage_rundir):
outdir = os.path.join(run_dir, 'parameter_with_nulls')
if not os.path.exists(outdir):
os.mkdir(outdir)
with gdxpds.gdx.GdxFile() as gdx:
gdx.append(
gdxpds.gdx.GdxSymbol('has_nulls',
gdxpds.gdx.GamsDataType.Parameter,
dims=1))
gdx[-1].dataframe = [['A', 1], ['B', None]]
assert gdx[-1].dataframe['Value'].isnull().values.any()
gdx.write(os.path.join(outdir, 'parameter_with_nulls_test.gdx'))
def test_unnamed_dimensions(manage_rundir):
outdir = os.path.join(run_dir, 'unnamed_dimensions')
if not os.path.exists(outdir):
os.mkdir(outdir)
# create a gdx file with all symbol types and 4 dimensions named '*'
cols = ['*'] * 4
some_entries = pds.DataFrame(
[['tech_1', 'year_2', 'low', 'h1'], ['tech_1', 'year_2', 'low', 'h2'],
['tech_1', 'year_2', 'low', 'h3'], ['tech_1', 'year_2', 'low', 'h4']],
columns=cols)
with gdxpds.gdx.GdxFile() as gdx:
# Set
gdx.append(
gdxpds.gdx.GdxSymbol('star_set',
gdxpds.gdx.GamsDataType.Set,
dims=4))
gdx[-1].dataframe = some_entries
# Parmeter
a_param = copy.deepcopy(some_entries)
a_param['Value'] = [1.0, 2.0, 3.0, 4.0]
gdx.append(
gdxpds.gdx.GdxSymbol('star_param',
gdxpds.gdx.GamsDataType.Parameter,
dims=4))
gdx[-1].dataframe = a_param
# Test changing the parameter data
a_param.iloc[:, 0] = 'tech_2'
gdx[-1].dataframe = pds.concat([gdx[-1].dataframe, a_param])
# Variable
gdx.append(
gdxpds.gdx.GdxSymbol(
'star_var',
gdxpds.gdx.GamsDataType.Variable,
dims=4,
variable_type=gdxpds.gdx.GamsVariableType.Positive))
a_var = copy.deepcopy(some_entries)
for value_col_name in gdx[-1].value_col_names:
a_var[value_col_name] = gdx[-1].get_value_col_default(
value_col_name)
gdx[-1].dataframe = a_var
# Equation
gdx.append(
gdxpds.gdx.GdxSymbol(
'star_eqn',
gdxpds.gdx.GamsDataType.Equation,
dims=4,
equation_type=gdxpds.gdx.GamsEquationType.GreaterThan))
an_eqn = copy.deepcopy(some_entries)
for value_col_name in gdx[-1].value_col_names:
an_eqn[value_col_name] = gdx[-1].get_value_col_default(
value_col_name)
gdx[-1].dataframe = an_eqn
gdx.write(os.path.join(outdir, 'star_symbols.gdx'))
with gdxpds.gdx.GdxFile(lazy_load=False) as gdx:
gdx.read(os.path.join(outdir, 'star_symbols.gdx'))
assert gdx['star_set'].num_dims == 4
assert gdx['star_set'].data_type == gdxpds.gdx.GamsDataType.Set
assert gdx['star_set'].variable_type is None
assert gdx['star_set'].equation_type is None
assert gdx['star_param'].num_dims == 4
assert gdx['star_param'].data_type == gdxpds.gdx.GamsDataType.Parameter
assert gdx['star_param'].variable_type is None
assert gdx['star_param'].equation_type is None
assert gdx['star_var'].num_dims == 4
assert gdx['star_var'].data_type == gdxpds.gdx.GamsDataType.Variable
assert gdx[
'star_var'].variable_type == gdxpds.gdx.GamsVariableType.Positive
assert gdx['star_var'].equation_type is None
assert gdx['star_eqn'].num_dims == 4
assert gdx['star_eqn'].data_type == gdxpds.gdx.GamsDataType.Equation
assert gdx['star_eqn'].variable_type is None
assert gdx[
'star_eqn'].equation_type == gdxpds.gdx.GamsEquationType.GreaterThan
def test_setting_dataframes(manage_rundir):
outdir = os.path.join(run_dir, 'setting_dataframes')
if not os.path.exists(outdir):
os.mkdir(outdir)
with gdxpds.gdx.GdxFile() as gdx:
# reading is tested elsewhere. here go through the different ways to
# set a dataframe.
# start with WAYS THAT WORK:
# 0 dims
# full dataframe
gdx.append(
gdxpds.gdx.GdxSymbol('sym_1', gdxpds.gdx.GamsDataType.Parameter))
gdx[-1].dataframe = pds.DataFrame([[2.0]])
assert list(gdx[-1].dataframe.columns) == ['Value']
# edit initialized dataframe - Parameter
gdx.append(
gdxpds.gdx.GdxSymbol('sym_2', gdxpds.gdx.GamsDataType.Parameter))
n = len(gdx[-1].dataframe.columns)
gdx[-1].dataframe['Value'] = [
5.0
] # list is required to specify number of rows to make
assert n == len(gdx[-1].dataframe.columns)
# list of lists
gdx.append(
gdxpds.gdx.GdxSymbol('sym_3', gdxpds.gdx.GamsDataType.Variable))
values = [3.0]
for value_col_name in gdx[-1].value_col_names:
if value_col_name == 'Level':
continue
values.append(gdx[-1].get_value_col_default(value_col_name))
gdx[-1].dataframe = [values]
# reset with empty list
gdx.append(
gdxpds.gdx.GdxSymbol('sym_4', gdxpds.gdx.GamsDataType.Parameter))
gdx[-1].dataframe = pds.DataFrame([[1.0]])
gdx[-1].dataframe = []
assert gdx[-1].num_records == 0
# > 0 dims - GdxSymbol initialized with dims=0
# full dataframe
gdx.append(
gdxpds.gdx.GdxSymbol('sym_5', gdxpds.gdx.GamsDataType.Parameter))
gdx[-1].dataframe = pds.DataFrame(
[['u1', 'CC', 8727.2], ['u2', 'CC', 7500.2], ['u3', 'CT', 9258.0]],
columns=['u', 'q', 'val'])
assert gdx[-1].num_dims == 2
assert gdx[-1].num_records == 3
# full list of lists
gdx.append(
gdxpds.gdx.GdxSymbol('sym_6', gdxpds.gdx.GamsDataType.Parameter))
gdx[-1].dataframe = [['u1', 'CC', 8727.2], ['u2', 'CC', 7500.2],
['u3', 'CT', 9258.0], ['u4', 'Coal', 10100.0]]
assert gdx[-1].num_dims == 2
assert gdx[-1].num_records == 4
# reset with empty list
gdx.append(
gdxpds.gdx.GdxSymbol('sym_7', gdxpds.gdx.GamsDataType.Parameter))
gdx[-1].dataframe = gdx[-2].dataframe.copy()
gdx[-1].dataframe = []
assert gdx[-1].num_dims == 2
assert gdx[-1].num_records == 0
# > 0 dims - GdxSymbol initialized with dims=n
# dataframe of dims
gdx.append(
gdxpds.gdx.GdxSymbol(
'sym_8',
gdxpds.gdx.GamsDataType.Variable,
dims=3,
variable_type=gdxpds.gdx.GamsVariableType.Positive))
gdx[-1].dataframe = pds.DataFrame([['u0', 'BES', 'c2'],
['u0', 'BES', 'c1'],
['u1', 'BES', 'c2']])
assert gdx[-1].num_dims == 3
assert gdx[-1].dims == ['*', '*', '*']
assert len(gdx[-1].dataframe.columns) > 3
gdx[-1].dataframe.loc[:, gdxpds.gdx.GamsValueType.Level.name] = 1.0
gdx[-1].dataframe.loc[:, gdxpds.gdx.GamsValueType.Upper.name] = 10.0
# full dataframe
gdx.append(
gdxpds.gdx.GdxSymbol('sym_9',
gdxpds.gdx.GamsDataType.Parameter,
dims=3))
gdx[-1].dataframe = pds.DataFrame(
[['u0', 'BES', 'c2', 2.0], ['u0', 'BES', 'c1', 1.0],
['u1', 'BES', 'c2', 2.0]],
columns=['u', 'q', 'c', 'storage_duration_h'])
assert list(gdx[-1].dataframe.columns) == ['u', 'q', 'c', 'Value']
# list of lists containing dims only
gdx.append(
gdxpds.gdx.GdxSymbol(
'sym_10',
gdxpds.gdx.GamsDataType.Equation,
dims=4,
equation_type=gdxpds.gdx.GamsEquationType.LessThan))
gdx[-1].dataframe = [['u0', 'PHES', 'c0', '1'],
['u0', 'PHES', 'c0', '2'],
['u0', 'PHES', 'c0', '3'],
['u0', 'PHES', 'c0', '4'],
['u0', 'PHES', 'c0', '5']]
gdx[-1].dataframe.loc[:, 'Level'] = -15.0
assert list(gdx[-1].dataframe.columns[:gdx[-1].num_dims]) == ['*'] * 4
# full list of lists
gdx.append(
gdxpds.gdx.GdxSymbol('sym_11', gdxpds.gdx.GamsDataType.Set,
dims=2))
gdx[-1].dataframe = [['PV', 'c0', True], ['CSP', 'c0', False],
['CSP', 'c1', False], ['Wind', 'c0', True]]
assert gdx[-1].num_dims == 2
# reset with empty list
gdx.append(
gdxpds.gdx.GdxSymbol('sym_12', gdxpds.gdx.GamsDataType.Set,
dims=2))
gdx[-1].dataframe = gdx[-1].dataframe.copy()
gdx[-1].dataframe = []
assert gdx[-1].num_dims == 2
assert gdx[-1].dims == ['*'] * 2
assert gdx[-1].num_records == 0
# > 0 dims - GdxSymbol initialized with dims=[list of actual dims]
# dataframe of dims
gdx.append(
gdxpds.gdx.GdxSymbol(
'sym_13',
gdxpds.gdx.GamsDataType.Variable,
dims=['u', 'q', 'c'],
variable_type=gdxpds.gdx.GamsVariableType.Positive))
gdx[-1].dataframe = pds.DataFrame([['u0', 'BES', 'c2'],
['u0', 'BES', 'c1'],
['u1', 'BES', 'c2']])
assert gdx[-1].num_dims == 3
assert gdx[-1].dims == ['u', 'q', 'c']
assert len(gdx[-1].dataframe.columns) > 3
gdx[-1].dataframe[gdxpds.gdx.GamsValueType.Level.name] = 1.0
gdx[-1].dataframe[gdxpds.gdx.GamsValueType.Upper.name] = 10.0
# full dataframe
gdx.append(
gdxpds.gdx.GdxSymbol('sym_14',
gdxpds.gdx.GamsDataType.Parameter,
dims=['u', 'q', 'c']))
gdx[-1].dataframe = pds.DataFrame(
[['u0', 'BES', 'c2', 2.0], ['u0', 'BES', 'c1', 1.0],
['u1', 'BES', 'c2', 2.0]],
columns=['u', 'q', 'c', 'storage_duration_h'])
assert list(gdx[-1].dataframe.columns) == ['u', 'q', 'c', 'Value']
# list of lists containing dims only
gdx.append(
gdxpds.gdx.GdxSymbol(
'sym_15',
gdxpds.gdx.GamsDataType.Equation,
dims=['u', 'q', 'c', 't'],
equation_type=gdxpds.gdx.GamsEquationType.LessThan))
gdx[-1].dataframe = [['u0', 'PHES', 'c0', '1'],
['u0', 'PHES', 'c0', '2'],
['u0', 'PHES', 'c0', '3'],
['u0', 'PHES', 'c0', '4'],
['u0', 'PHES', 'c0', '5']]
gdx[-1].dataframe['Level'] = -15.0
assert list(gdx[-1].dataframe.columns[:gdx[-1].num_dims]) == [
'u', 'q', 'c', 't'
]
# full list of lists
gdx.append(
gdxpds.gdx.GdxSymbol('sym_16',
gdxpds.gdx.GamsDataType.Set,
dims=['q', 'c']))
gdx[-1].dataframe = [['PV', 'c0', True], ['CSP', 'c0', False],
['CSP', 'c1', False], ['Wind', 'c0', True]]
assert gdx[-1].num_dims == 2
# reset with empty list
gdx.append(
gdxpds.gdx.GdxSymbol('sym_17',
gdxpds.gdx.GamsDataType.Set,
dims=['q', 'c']))
gdx[-1].dataframe = gdx['sym_11'].dataframe.copy()
gdx[-1].dataframe = []
assert gdx[-1].num_dims == 2
assert list(gdx[-1].dataframe.columns[:gdx[-1].num_dims]) == ['*'] * 2
assert gdx[-1].num_records == 0
# And then document that some ways DO NOT WORK:
# dims=0
# set value, then try to set different number of dimensions
gdx.append(
gdxpds.gdx.GdxSymbol('sym_18',
gdxpds.gdx.GamsDataType.Parameter,
dims=0))
gdx[-1].dataframe = [[3]]
with pytest.raises(Error) as excinfo:
gdx[-1].dims = 3
assert "Cannot set dims to 3" in str(excinfo.value)
# dims > 0
# explicitly set dims to something else
gdx.append(
gdxpds.gdx.GdxSymbol('sym_19',
gdxpds.gdx.GamsDataType.Parameter,
dims=['g', 't']))
with pytest.raises(Exception) as excinfo:
gdx[-1].dims = ['g', 't', 'd']
assert "Cannot set dims" in str(excinfo.value)
# dataframe of different number of dims
gdx.append(
gdxpds.gdx.GdxSymbol('sym_20',
gdxpds.gdx.GamsDataType.Variable,
dims=['d', 't']))
gdx[-1].dataframe = [['d1', '1'], ['d1', '2'], ['d1', '3']]
tmp = gdx[-1].dataframe.copy()
cols = list(tmp.columns)
tmp['q'] = 'PV'
tmp = tmp[['q'] + cols]
with pytest.raises(Exception) as _excinfo:
gdx[-1].dataframe = tmp
# full dataframe of different number of dims
gdx.append(
gdxpds.gdx.GdxSymbol('sym_21',
gdxpds.gdx.GamsDataType.Parameter,
dims=6))
assert gdx[-1].dims == ['*'] * 6
with pytest.raises(Exception) as e_info:
gdx[-1].dataframe = pds.DataFrame([['1', 6.0], ['2', 7.0],
['3', -12.0]])
# list of lists of varying widths
gdx.append(
gdxpds.gdx.GdxSymbol('sym_22',
gdxpds.gdx.GamsDataType.Parameter,
dims=3))
with pytest.raises(Exception) as e_info:
gdx[-1].dataframe = [[1]]
with pytest.raises(Exception) as e_info:
gdx[-1].dataframe = [['1', 2.5], ['2', -30.0]]
# TODO: Write test where parameter value ends up as set dimension--does
# an exception get thrown upon writing to GDX?
with pytest.raises(Exception) as e_info:
gdx[-1].dataframe = [['u1', 'PV', 'c0', '1', 2.5],
['u1', 'PV', 'c0', '2', -30.0]]
gdx.write(os.path.join(outdir, 'dataframe_set_tests.gdx'))
with gdxpds.gdx.GdxFile(lazy_load=False) as gdx:
gdx.read(os.path.join(outdir, 'dataframe_set_tests.gdx'))
assert gdx['sym_1'].num_records == 1
assert gdx['sym_2'].num_records == 1
assert gdx['sym_3'].num_records == 1
assert gdx[
'sym_4'].num_records == 1 # GAMS defaults empty 0-dim parameter to 0
assert gdx['sym_4'].dataframe['Value'].values[0] == 0.0
assert gdx['sym_5'].dims == ['u', 'q']
assert gdx['sym_5'].num_records == 3
assert gdx['sym_5'].dataframe['Value'].values[1] == 7500.2
assert gdx['sym_6'].num_records == 4
assert gdx['sym_7'].num_records == 0
assert gdx['sym_8'].dims == ['*'] * 3
assert gdx['sym_8'].dataframe[
gdxpds.gdx.GamsValueType.Upper.name].values[0] == 10.0
assert gdx['sym_9'].num_records == 3
assert gdx['sym_10'].num_dims == 4
assert gdx['sym_11'].num_dims == 2
assert gdx['sym_11'].num_records == 4
# ETH@20181007 - Tried to test for some values being c_bool(False) in sym_11, but
# c_bool(True) != c_bool(True), so that makes it hard to test such things.
# Also, c_bool(False) appears to be interpreted as True in GDX. Ick and yikes.
assert gdx['sym_12'].num_dims == 2
assert gdx['sym_12'].num_records == 0
assert gdx['sym_13'].dims == ['u', 'q', 'c']
assert gdx['sym_13'].dataframe[
gdxpds.gdx.GamsValueType.Upper.name].values[0] == 10.0
assert gdx['sym_14'].num_records == 3
assert gdx['sym_15'].num_dims == 4
assert gdx['sym_16'].num_dims == 2
assert gdx['sym_16'].num_records == 4
assert gdx['sym_17'].num_dims == 2
assert gdx['sym_17'].num_records == 0
# https://github.com/NREL/gdx-pandas
import pandas as pds
# import XlsxWriter
import gdxpds
from ctypes import c_bool
import logging
import gdxpds.gdx
out_file = 'my_new_gdx_data.gdx'
with gdxpds.gdx.GdxFile() as gdx:
# Create a new set with one dimension
gdx.append(
gdxpds.gdx.GdxSymbol('my_set', gdxpds.gdx.GamsDataType.Set,
dims=['u']))
data = pds.DataFrame([['u' + str(i)] for i in range(1, 11)])
data['Value'] = True
gdx[-1].dataframe = data
# Create a new parameter with one dimension
gdx.append(
gdxpds.gdx.GdxSymbol('my_parameter',
gdxpds.gdx.GamsDataType.Parameter,
dims=['u']))
data = pds.DataFrame([['u' + str(i), i * 100] for i in range(1, 11)],
columns=(gdx[-1].dims + gdx[-1].value_col_names))
gdx[-1].dataframe = data
gdx.write(out_file)