Merge pull request #99 from NREL/eh/prep_release

Updating version number, changes, and documentation

.gitignore

@@ -9,3 +9,5 @@ build
 
 .pytest_cache
 gdxpds/test/pytest.log
+
+.vscode

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

doc/source/api/gdxpds.rst

@@ -66,4 +66,6 @@ Module contents
 
 .. autofunction:: gdxpds.list_symbols
 
+.. autofunction:: gdxpds.get_data_types
+
 .. autofunction:: gdxpds.to_gdx

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.)

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"

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
     -------