Skip to main content
Ctrl+K
LSST Science Pipelines - Home LSST Science Pipelines - Home
  • Getting started with the LSST Science Pipelines
  • Installing the LSST Science Pipelines
  • Data access and pipeline middleware
  • lsst.afw.cameraGeom
  • lsst.afw.coord
    • lsst.afw.detection
    • lsst.afw.display
    • lsst.afw.fits
    • lsst.afw.formatters
    • lsst.afw.geom
    • lsst.afw.image
    • lsst.afw.math
    • lsst.afw.table
    • lsst.afw.typehandling
    • lsst.alert.packet
    • lsst.analysis.ap
    • lsst.analysis.tools
    • lsst.ap.association
    • lsst.ap.pipe
    • lsst.ap.verify
    • lsst.base
    • lsst.cbp
    • lsst.cell_coadds
    • lsst.coadd.utils
    • lsst.cp.pipe
    • lsst.ctrl.bps.htcondor
    • lsst.ctrl.bps.panda
    • lsst.ctrl.bps.parsl
    • lsst.ctrl.bps
    • lsst.ctrl.mpexec
    • lsst.daf.butler
    • lsst.dax.apdb
    • lsst.dax.images.cutout
    • lsst.display.ds9
    • lsst.display.firefly
    • lsst.drp.pipe
    • lsst.drp.tasks
    • lsst.faro.base
    • lsst.faro.measurement
    • lsst.faro.preparation
    • lsst.faro.summary
    • lsst.faro.utils
    • lsst.faro
    • lsst.fgcmcal
    • lsst.gauss2d.fit
    • lsst.gauss2d
    • lsst.geom
    • lsst.ip.diffim
    • lsst.ip.isr
    • lsst.jointcal
    • lsst.log
    • lsst.meas.algorithms
    • lsst.meas.astrom
    • lsst.meas.base
    • lsst.meas.deblender
    • lsst.meas.extensions.gaap
    • lsst.meas.extensions.multiprofit
    • lsst.meas.extensions.photometryKron
    • lsst.meas.extensions.piff
    • lsst.meas.extensions.psfex
    • lsst.meas.extensions.scarlet
    • lsst.meas.extensions.shapeHSM
    • lsst.meas.extensions.simpleShape
    • lsst.meas.extensions.trailedSources
    • lsst.meas.modelfit
    • lsst.meas.transiNet
    • lsst.modelfit.parameters
    • lsst.multiprofit
    • lsst.obs.base
    • lsst.obs.cfht
    • lsst.obs.decam
    • lsst.obs.lsst
    • lsst.pex.config
    • lsst.pex.exceptions
    • lsst.pipe.base
    • lsst.pipe.tasks
    • lsst.resources
    • lsst.sconsUtils
    • lsst.sdm.tools
    • lsst.shapelet
    • lsst.skymap
    • lsst.source.injection
    • lsst.utils
    • lsst.verify
    • Release History
    • Known Issues
    • Characterization Metric Reports
    • Tasks
    • Rubin docs
  • GitHub
  • Getting started with the LSST Science Pipelines
  • Installing the LSST Science Pipelines
  • Data access and pipeline middleware
  • lsst.afw.cameraGeom
  • lsst.afw.coord
  • lsst.afw.detection
  • lsst.afw.display
  • lsst.afw.fits
  • lsst.afw.formatters
  • lsst.afw.geom
  • lsst.afw.image
  • lsst.afw.math
  • lsst.afw.table
  • lsst.afw.typehandling
  • lsst.alert.packet
  • lsst.analysis.ap
  • lsst.analysis.tools
  • lsst.ap.association
  • lsst.ap.pipe
  • lsst.ap.verify
  • lsst.base
  • lsst.cbp
  • lsst.cell_coadds
  • lsst.coadd.utils
  • lsst.cp.pipe
  • lsst.ctrl.bps.htcondor
  • lsst.ctrl.bps.panda
  • lsst.ctrl.bps.parsl
  • lsst.ctrl.bps
  • lsst.ctrl.mpexec
  • lsst.daf.butler
  • lsst.dax.apdb
  • lsst.dax.images.cutout
  • lsst.display.ds9
  • lsst.display.firefly
  • lsst.drp.pipe
  • lsst.drp.tasks
  • lsst.faro.base
  • lsst.faro.measurement
  • lsst.faro.preparation
  • lsst.faro.summary
  • lsst.faro.utils
  • lsst.faro
  • lsst.fgcmcal
  • lsst.gauss2d.fit
  • lsst.gauss2d
  • lsst.geom
  • lsst.ip.diffim
  • lsst.ip.isr
  • lsst.jointcal
  • lsst.log
  • lsst.meas.algorithms
  • lsst.meas.astrom
  • lsst.meas.base
  • lsst.meas.deblender
  • lsst.meas.extensions.gaap
  • lsst.meas.extensions.multiprofit
  • lsst.meas.extensions.photometryKron
  • lsst.meas.extensions.piff
  • lsst.meas.extensions.psfex
  • lsst.meas.extensions.scarlet
  • lsst.meas.extensions.shapeHSM
  • lsst.meas.extensions.simpleShape
  • lsst.meas.extensions.trailedSources
  • lsst.meas.modelfit
  • lsst.meas.transiNet
  • lsst.modelfit.parameters
  • lsst.multiprofit
  • lsst.obs.base
  • lsst.obs.cfht
  • lsst.obs.decam
  • lsst.obs.lsst
  • lsst.pex.config
  • lsst.pex.exceptions
  • lsst.pipe.base
  • lsst.pipe.tasks
  • lsst.resources
  • lsst.sconsUtils
  • lsst.sdm.tools
  • lsst.shapelet
  • lsst.skymap
  • lsst.source.injection
  • lsst.utils
  • lsst.verify
  • Release History
  • Known Issues
  • Characterization Metric Reports
  • Tasks
  • Rubin docs
  • GitHub

Section Navigation

  • Resources v29.1.0 (2025-06-13)
  • S3 ResourcePath
  • webDAV ResourcePath
  • ResourceHandleProtocol
  • ResourcePath
  • Internal API reference
    • get_tempdir
    • os2posix
    • posix2os
    • NoTransaction
    • TransactionProtocol
    • BaseResourceHandle
    • CloseStatus
    • ResourceHandleProtocol
    • FileResourceHandle
  • lsst.resources

lsst.resources#

Changes#

  • Resources v29.1.0 (2025-06-13)
  • Resources v29.0.0 (2025-03-25)
  • Resources v28.0.0 (2024-11-20)
  • Resources 27.0.0 (2024-05-28)
  • Resources v26.0.0 (2023-09-22)
  • Resources v25.0.0 (2023-02-27)
  • Resources v24.0.0 (2022-08-26)

Design and Development#

lsst.resources is developed at lsst/resources.

It is available from PyPI as lsst-resources: https://pypi.org/project/lsst-resources/

Configuration#

  • S3 ResourcePath
    • Configuration
      • Choosing an S3 service
      • Authentication credentials
      • Using multiple S3 services or sets of credentials
  • webDAV ResourcePath
    • Configuration
      • Configuration settings
    • Configuration Examples
      • dCache
      • XRootD

Python API reference#

lsst.resources Package#

Classes#

ResourceHandleProtocol(*args, **kwargs)

Defines the interface protocol that is compatible with children of BaseResourceHandle.

ResourcePath(uri[, root, forceAbsolute, ...])

Convenience wrapper around URI parsers.

Class Inheritance Diagram#

Inheritance diagram of lsst.resources._resourceHandles._baseResourceHandle.ResourceHandleProtocol, lsst.resources._resourcePath.ResourcePath

See also Internal API reference.

previous

VisualizeMosaicCalibFilterTask

next

Resources v29.1.0 (2025-06-13)

On this page
  • Changes
  • Design and Development
  • Configuration
  • Python API reference
    • lsst.resources Package
      • Classes
      • Class Inheritance Diagram
Edit on GitHub

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.