bulum.utils package

The bulum utils subpackage provides support and miscellaneous useful functions for the rest of the bulum package, particularly in manipulating datetime and dataframes.

The bulum utils subpackage provides support and miscellaneous useful functions for the rest of the bulum package.

• TimeseriesDataframes are extensions of Pandas DataFrames with extra metadata.

• DataframeEnsembles are collections of TimeseriesDataframes, for example to store the results of multiple scenarios.

—EXAMPLES—

Submodules

• bulum.utils.dataframe_extensions module
  • DataframeEnsemble
    • DataframeEnsemble.add_dataframe()
    • DataframeEnsemble.add_tag()
    • DataframeEnsemble.assert_df_shape_matches_ensemble()
    • DataframeEnsemble.df_shape_matches_ensemble()
    • DataframeEnsemble.filter_tag()
    • DataframeEnsemble.get()
    • DataframeEnsemble.load()
    • DataframeEnsemble.map()
    • DataframeEnsemble.print_summary()
    • DataframeEnsemble.save()
  • RegexArg
    • RegexArg.OBJECT
    • RegexArg.PATTERN
  • TimeseriesDataframe
    • TimeseriesDataframe.TAG_DELIMITER
    • TimeseriesDataframe.add_tag()
    • TimeseriesDataframe.count_tags()
    • TimeseriesDataframe.from_dataframe()
    • TimeseriesDataframe.has_tag()
    • TimeseriesDataframe.load()
    • TimeseriesDataframe.metadata_fields()
    • TimeseriesDataframe.print_summary()
    • TimeseriesDataframe.save()
    • TimeseriesDataframe.tsdf_apply()
• bulum.utils.dataframe_functions module
  • assert_df_format_standards()
  • assert_df_has_one_column()
  • check_data_equivalence()
  • check_df_format_standards()
  • convert_index_to_datetime()
  • convert_index_to_string()
  • crop_to_wy()
  • datetimes_to_strings()
  • find_col()
  • set_index_dt()
  • strings_to_datetimes()
• bulum.utils.datetime_functions module
  • get_date_format()
  • get_dates()
  • get_month()
  • get_next_month_start()
  • get_prev_month_end()
  • get_this_month_end()
  • get_wy()
  • get_wy_end_date()
  • get_wy_start_date()
  • get_year_and_month()
  • standardise_datestring_format()
  • standardize_datestring_format()
  • to_np_datetimes64d()
• bulum.utils.interpolation module
  • interp()