iiasa / ixmp

The ix modeling platform for integrated and cross-cutting scenario analysis
https://docs.messageix.org/ixmp
Apache License 2.0
37 stars 110 forks source link

Geodata features are not properly documented #187

Open khaeru opened 4 years ago

khaeru commented 4 years ago

186 (superseding #165) added methods TimeSeries.add_geodata, TimeSeries.geodata, etc. These are not fully documented.

However, a new user who reads the actual documentation will not see either of these clues, and so will be mystified about:

At a minimum, these things need to be added to the method docstrings.

khaeru commented 4 years ago

I updated #182 to incorporate these methods.

The necessary code reveals that the signatures and return values of the Java get/set/delete methods for ordinary (float) timeseries data, and timeseries geodata, are quite different, even though (per above) the only substantive difference seems to be the type of the 'value' column.

If these discrepancies could be cleaned up on the Java side, then the JDBCBackend could also be simplified.