frb.builds.build_frbs

Top-level module to build or re-build the JSON files for FRBs

frb.builds.build_frbs.run(frb_input: Series, lit_refs: str = None, override: bool = False, out_path: str = None, outfile: str = None)[source]

Main method for generating a Host JSON file

Args:

  • frb_input (pandas.core.series.Series) – Row of the CVS file providing the frb items

  • lit_refs (str, optional) – File of literature references. Defaults to None.

  • override (bool, optional) – Attempt to over-ride errors. Mainly for time-outs of public data. Defaults to False.

  • outfile (str, optional) – Over-ride default outfile [not recommended; mainly for testing]

  • out_path (str, optional) – Over-ride default outfile [not recommended; mainly for testing]

Raises:

  • e – [description]

  • ValueError – [description]

frb.builds.build_frbs.main(frbs: list, options: str = None, data_file: str = None, lit_refs: str = None, override: bool = False, outfile: str = None, out_path: str = None)[source]

Driver of the analysis

Args:

  • frbs (list) – [description]

  • options (str, optional) – [description]. Defaults to None.

  • data_file (str, optional) – Alternate table than default for building FRBs. Defaults to None.

  • lit_refs (str, optional) – [description]. Defaults to None.

  • override (bool, optional) – [description]. Defaults to False.

  • outfile (str, optional) – [description]. Defaults to None. Here for testing

  • out_path (str, optional) – [description]. Defaults to None. Here for testing