Skip to main content
Back to top
Ctrl
+
K
Getting started with the LSST Science Pipelines
Installing the LSST Science Pipelines
Data access and pipeline middleware
lsst.afw.cameraGeom
lsst.afw.coord
More
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
Search
Ctrl
+
K
GitHub
Search
Ctrl
+
K
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
Butler v29.1.0 (2025-06-13)
Configuring a Butler
Datastore Configuration
Storage Classes, Storage Class Delegates, and Formatters
Organizing and identifying datasets
Querying datasets
Using the Butler in unit tests
Overview
DataFrame
Specifying Command-Line Options from a File
Controlling Log Output from Command-Line Tooling
Design notes for
DataCoordinate
Support Entry Points
The Butler Command
addDimensionForeignKey
AmbiguousDatasetError
Butler
ButlerCollections
ButlerConfig
ButlerLogRecords
ButlerMetrics
ButlerRepoIndex
ButlerUserError
CalibrationLookupError
CollectionCycleError
CollectionInfo
CollectionType
CollectionTypeError
Config
ConfigSubset
DataCoordinate
DataCoordinateIterable
DataCoordinateSequence
DataCoordinateSet
DataIdValueError
DatabaseDimension
DatabaseDimensionCombination
DatabaseDimensionElement
DatabaseTopologicalFamily
DatasetAssociation
DatasetComponent
DatasetExistence
DatasetIdFactory
DatasetIdGenEnum
DatasetNotFoundError
DatasetProvenance
DatasetRef
DatasetType
DatasetTypeNotSupportedError
Datastore
DeferredDatasetHandle
Dimension
DimensionCombination
DimensionConfig
DimensionDataAttacher
DimensionDataExtractor
DimensionElement
DimensionGroup
DimensionNameError
DimensionPacker
DimensionRecord
DimensionRecordFactory
DimensionRecordSchema
DimensionRecordSet
DimensionRecordSetDeserializer
DimensionRecordTable
DimensionRecordsAccumulator
DimensionUniverse
EmptyQueryResultError
FileDataset
FileDescriptor
FileIntegrityError
Formatter
FormatterFactory
FormatterNotImplementedError
FormatterV1inV2
FormatterV2
GovernorDimension
InconsistentDataIdError
InvalidQueryError
LabeledButlerFactory
LabeledButlerFactoryProtocol
LimitedButler
Location
LocationFactory
LookupKey
MissingCollectionError
MissingDatasetTypeError
NameMappingSetView
NamedKeyDict
NamedKeyMapping
NamedValueAbstractSet
NamedValueMutableSet
NamedValueSet
NoDefaultCollectionError
Progress
Quantum
QuantumBackedButler
QuantumProvenanceData
Registry
RepoExportContext
SerializableDimensionData
SerializedDataCoordinate
SerializedDatasetRef
SerializedDatasetRefContainerV1
SerializedDatasetType
SerializedDimensionConfig
SerializedDimensionRecord
SerializedFileDataset
SerializedQuantum
SkyPixDimension
SkyPixSystem
StorageClass
StorageClassConfig
StorageClassDelegate
StorageClassFactory
Timespan
TopologicalFamily
TopologicalRelationshipEndpoint
TopologicalSpace
UnknownComponentError
ValidationError
YamlRepoExportBackend
YamlRepoImportBackend
DataCoordinateQueryResults
DatasetRefQueryResults
DimensionRecordQueryResults
GeneralQueryResults
GeneralResultTuple
Query
QueryBase
QueryResultsBase
ExpressionFactory
ExpressionProxy
RegionProxy
ScalarExpressionProxy
TimespanProxy
ChainedDatastore
InMemoryDatastore
StoredMemoryItemInfo
FileDatastore
FileFormatter
JsonFormatter
MatplotlibFormatter
add_pandas_index_to_astropy
arrow_schema_to_pandas_index
arrow_to_astropy
arrow_to_numpy
arrow_to_numpy_dict
arrow_to_pandas
astropy_to_arrow
astropy_to_pandas
compute_row_group_size
numpy_dict_to_arrow
numpy_to_arrow
numpy_to_astropy
pandas_to_arrow
pandas_to_astropy
ArrowAstropySchema
ArrowNumpySchema
DataFrameSchema
ParquetFormatter
PickleFormatter
YamlFormatter
addDataIdValue
addDatasetType
expandUniqueId
makeTestCollection
makeTestRepo
registerMetricsExample
BadNoWriteFormatter
BadWriteFormatter
CliCmdTestBase
CliLogTestBase
DatasetTestHelper
DatastoreMock
DatastoreTestHelper
DummyRegistry
ListDelegate
MetricsDelegate
MetricsExample
MetricsExampleDataclass
MetricsExampleModel
MultiDetectorFormatter
DatasetRefURIs
DatastoreConfig
DatastoreOpaqueTable
DatastoreTransaction
DatastoreValidationError
FileTransferRecord
FileTransferSource
NullDatastore
Predicate
ArgumentError
CollectionExpressionError
CollectionSummary
ConflictingDefinitionError
DatasetTypeExpressionError
MissingSpatialOverlapError
NoDefaultCollectionError
OrphanedRecordError
RegistryConfig
RegistryConsistencyError
RegistryDefaults
SerializedCollectionSummary
UnsupportedIdGeneratorError
UserExpressionError
UserExpressionSyntaxError
ButlerAttributeExistsError
ButlerAttributeManager
ChainedCollectionRecord
CollectionManager
CollectionRecord
Database
DatabaseConflictError
DatabaseInsertMode
DatabaseMetadata
DatasetRecordStorageManager
DatastoreRegistryBridge
DatastoreRegistryBridgeManager
DimensionRecordStorageManager
FakeDatasetRef
IncompatibleVersionError
JoinedCollectionsTable
ObsCoreTableManager
OpaqueTableStorage
OpaqueTableStorageManager
ReadOnlyDatabaseError
RunRecord
SchemaAlreadyDefinedError
StaticTablesContext
VersionTuple
VersionedExtension
ChainedDatasetQueryResults
DataCoordinateQueryResults
DatasetQueryResults
DimensionRecordQueryResults
ParentDatasetQueryResults
QueryResultsBase
CategorizedWildcard
CollectionWildcard
DatasetTypeWildcard
SqliteDatabase
PostgresqlDatabase
DateTimeArrowScalar
DateTimeArrowType
RegionArrowScalar
RegionArrowType
TimespanArrowScalar
TimespanArrowType
ToArrow
UUIDArrowScalar
UUIDArrowType
make_tuple_type_adapter
BoolColumnSpec
FloatColumnSpec
HashColumnSpec
IntColumnSpec
RegionColumnSpec
StringColumnSpec
TimespanColumnSpec
UUIDColumnSpec
GUID
AstropyTimeNsecTai
Base64Bytes
Base64Region
FieldSpec
ForeignKeySpec
IndexSpec
TableSpec
from_json_generic
from_json_pydantic
to_json_generic
to_json_pydantic
ButlerLogRecord
ButlerLogRecordHandler
ButlerLogRecords
ButlerMDC
JsonLogFormatter
MappingFactory
NonemptyMapping
PersistenceContextVars
Progress
ProgressBar
ProgressHandler
get_universe_from_context
DeferredValidation
replaceRoot
BUTLER_ROOT_TAG
TimeConverter
TimespanDatabaseRepresentation
stripIfNotNone
transactional
main
ButlerCLI
LoaderCLI
associate
butler_import
certify_calibrations
create
collection_chain
config_dump
config_validate
export_calibs
ingest_files
ingest_zip
prune_datasets
query_collections
query_data_ids
query_dataset_types
query_datasets
query_dimension_records
register_dataset_type
retrieve_artifacts
remove_collections
remove_runs
remove_dataset_type
transfer_datasets
CollectionTypeCallback
query_datasets_options
collection_argument
collection_type_option
collections_argument
collections_option
config_file_option
config_option
confirm_option
dataset_type_option
datasets_option
destination_argument
dimensions_argument
directory_argument
element_argument
glob_argument
limit_option
locations_argument
log_file_option
log_label_option
log_level_option
log_tty_option
long_log_option
offset_option
options_file_option
order_by_option
processes_option
regex_option
register_dataset_types_option
repo_argument
run_option
track_file_attrs_option
transfer_dimensions_option
transfer_option
transfer_option_no_short
verbose_option
where_option
addArgumentHelp
astropyTablesToStr
catch_and_exit
clickResultMsg
command_test_env
printAstropyTables
sortAstropyTable
split_commas
split_kv
textTypeStr
to_upper
unwrap
yaml_presets
ButlerCommand
LogCliRunner
MWArgument
MWArgumentDecorator
MWCommand
MWCtxObj
MWOption
MWOptionDecorator
MWPath
OptionGroup
OptionSection
option_section
CliLog
PrecisionLogFormatter
ClickProgressHandler
lsst.daf.butler
main
main
#
lsst.daf.butler.cli.butler.
main
(
)
→
Command
#
Return main entry point for command-line.
On this page
main()
Edit on GitHub
