Utility Functions and Classes

Utility Functions and Classes#

`is_filepath_like`(obj)	Test if object type is compatible with `gsolve.core._typing.FilePath`.
`is_datetime_array`(v)	Test if the input is a datetime-like array.
`is_points3d_like`(v)	Test if value is compatible with Points3D type.
`is_in_literal`(value, literal_type)	Test if value is in a Literal type.

`to_1d_ndarray`(a[, expected_size, ...])	Convert input to a 1D numpy array.
`to_1d_ndarray_or_float`(a[, dtype])	Convert input to a 1D numpy array or a float.
`to_naive_utc_datetime`(t[, allow_nat])	Convert inputs to UTC time, but with timezone information set to None.
`to_points3d`(v)	Convert Points3d-like object to a bona-fide Points3D object.
`normalize_field_names`(df)	Return a copy of `df` with column values and axis.names converted to snake_case.
`normalize_str`(s)	Convert `s` to str and format it to snake_case.
`check_duplicate_index`(idx)	Raise a ValueError if the index contains duplicate values.

`columns_to_timestamp`(df[, ts_columns])	Generate a Series of Timestamps from discrete date & time columns in `df`.
`timestamp_to_columns`(ds[, resolution, ...])	Convert a Series of `pandas.Timestamp` to discrete date & time columns.
`merge_datetime_columns`(df[, name, ...])	Merge discrete datetime columns into `pandas.Timestamp`.
`expand_datetime_column`(df, *[, column_name, ...])	Expand datetime column(s) to discrete date and time component columns.
`prepare_writable_df`(df, *[, ...])	Prepare a DataFrame for writing to a file.

`generate_loop_intervals`(datetime_bounds)	Generate time intervals from a sequence of datetimes.
`generate_loop_names`(n[, start, step, format_str])	Generate loop identifier strings.
`identify_loop_blocks`(datetimes, gap[, ...])	Identify loop blocks in a sequence of datetimes based on gaps.
`loops_from_gaps`(datetimes, gap[, ...])	Generate loops from gaps in a sequence of datetimes and assign loop id's.

`dms2rad`(d, m, s)	Convert angles from degree-minutes-seconds to radians.
`round_coords`(arr)	Round values in `arr`, with halfway cases rounded towards positive infinity.

`GSolveDataWarning`(prefix[, show])	A convenience class for collecting and displaying warning messages.
`GSolveDataWarning.count`	Count of messages added - i.e. the number of issues.
`GSolveDataWarning.final_msg`()	Print closing summary message.
`GSolveDataWarning.print_msgs`()	Print all stored warning messages.