From 415b56f61b2f6a949a668f73cea98a5387307470 Mon Sep 17 00:00:00 2001 From: Elaine Hale Date: Fri, 21 Jul 2023 16:45:02 -0600 Subject: [PATCH] Updating version number, changes, and documentation --- .gitignore | 2 ++ CHANGES.txt | 2 ++ doc/source/api/gdxpds.rst | 2 ++ doc/source/overview.rst | 1 + gdxpds/_version.py | 2 +- gdxpds/read_gdx.py | 4 ++-- 6 files changed, 10 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index e0ce2d1..8e71ce1 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,5 @@ build .pytest_cache gdxpds/test/pytest.log + +.vscode \ No newline at end of file diff --git a/CHANGES.txt b/CHANGES.txt index 3180823..0428723 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,3 +1,5 @@ +v1.4.0, 07/21/23 -- add get_data_types function that maps symbol name to gdx.GamsDataType; + add load_set_text kwarg to gdx.GdxSymbol.load, to_dataframe, and to_dataframes v1.3.0, 05/09/23 -- performance improvements (faster read and write) GAMS directory finder improvements documentation improvements diff --git a/doc/source/api/gdxpds.rst b/doc/source/api/gdxpds.rst index 92707ee..e16167c 100644 --- a/doc/source/api/gdxpds.rst +++ b/doc/source/api/gdxpds.rst @@ -66,4 +66,6 @@ Module contents .. autofunction:: gdxpds.list_symbols +.. autofunction:: gdxpds.get_data_types + .. autofunction:: gdxpds.to_gdx diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 30c985f..c6e3a38 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -56,6 +56,7 @@ returned as an object of type :py:class:`gdxpds.gdx.GdxFile`. Additional functions include: - :py:func:`gdxpds.list_symbols` +- :py:func:`gdxpds.get_data_types` - :py:func:`gdxpds.to_dataframe` (If the call to this method includes old_interface=False, then the return value will be a plain DataFrame, not a {‘symbol_name’: df} dict.) diff --git a/gdxpds/_version.py b/gdxpds/_version.py index 55f8957..293fc1a 100644 --- a/gdxpds/_version.py +++ b/gdxpds/_version.py @@ -3,7 +3,7 @@ __title__ = "gdxpds" __description__ = "gdx-pandas is a python package to translate between gdx (GAMS data) and pandas" __url__ = "https://github.com/NREL/gdx-pandas" -__version__ = "1.3.0" +__version__ = "1.4.0" __author__ = "Elaine T. Hale" __author_email__ = "elaine.hale@nrel.gov" __license__ = "BSD-3" diff --git a/gdxpds/read_gdx.py b/gdxpds/read_gdx.py index c8ecff9..e6e67e8 100644 --- a/gdxpds/read_gdx.py +++ b/gdxpds/read_gdx.py @@ -90,8 +90,8 @@ def to_dataframes(gdx_file,gams_dir=None,load_set_text=False): gams_dir : None or pathlib.Path or str optional path to GAMS directory load_set_text : bool - If True (default is False) and symbol_name is a Set, loads the GDX Text - field into the dataframe rather than a `c_bool`. + If True (default is False), then for every symbol that is a Set, loads + the GDX Text field into the dataframe rather than a `c_bool`. Returns -------