Functions

readparse.pullPARSE(sharpnum, parseind=0, folder='./parsedata', overwrite=False)

Download a specified PARSE data element.

Parameters
  • sharpnum – Integer corresponding to the SHARP number the PARSE was generated from.

  • parseind (int) – The realization index for the desired PARSE. Omit or set to 0 for the NLFFF extrapolation

  • folder (String) – Optional specification of the directory the data should be downloaded to.

  • overwrite (bool) – Whether new data should be re-downloaded in the event a PARSE with the specified sharp and parse indices is present in the download folder. Default False

readparse.readPARSE(fid, folder='./parsedata')

Read a specified PARSE fits file in as a PARSE object.

Parameters
  • fid (String or tuple) – A specification of the file to read. If fid is a String, it will read that file. Include the relative directory; the folder parameter is ignored. If fid is a tuple (sharpnum, parseind), it will look for a file with that specification.

  • folder (String) – the folder in which to find the fits file, if the tuple specification of fid is used.

Returns

The data object read in from the file

Return type

PARSE