swifttools.ukssdc.xrt_prods
moduleLatest version v1.10, released in swifttools v3.0 (Release notes)
The swifttools.ukssdc.xrt_prods
module provides the means to build Swift-XRT data products for point sources,
and is based on the online tools. You will need to be registered to use this service.
This documentation describes how to use the Python interface. We assume that you are already familiar with the tools themselves, and do not here describe their operation, allowable data formats (e.g. time systems supported) or the detailed meanings of the various parameters. For this, please read the product generator documentation.
We still have a finite capacity, so please do not submit large numbers of jobs en masse; instead you can use the API to submit all of your jobs, but a few at a time, waiting until the requested jobs have completed before submitting the next tranche (examples).
The release of swifttools
v3.0, including the new swifttools.ukssdc
module
necessitated a few changes to the xrt_prods
module, in order to ensure homogeneous behaviour and formatting. These
are documented in the version 1.10 release notes. The key points to note are:
XRTProductRequest.useDeprecate = True
at the start of your scripts.swifttools.xrt_prods
module is now swifttools.ukssdc.xrt_prods
; however swifttools.xrt_prods
continues to serve
as a wrapper to this.In addition, due to the increased complexity of the system, we are no longer supporting (or documenting) the raw API, but only the Python module. No-one has used the raw API since November 2020, and I think that was just me, testing, so we don't expect this to inconvenience anyone.