RAIL_Projects

Getting Started

  • Overview
    • RAIL Overview
    • rail.projects Overview
    • rail.plotting Overview
  • Installation
    • Production Installation
    • Exploration Installation
    • Developer Installation
    • RAIL packages
    • Adding your kernel to jupyter

Concepts

  • RailProject
    • RailProject basics
    • Rail Project Functionality
    • Rail Project Configuration
  • Pipelines
    • Pipelines basics
      • Running a Pipline of a Catalog
      • Running a Pipline single set of inputs
    • Pipeline definitions
    • Building pipelines with rail.projects
    • Running pipelines with rail.projects
  • Analysis Flavors
    • Flavor basics
    • Flavor definitions
  • Components, Factories, and Libraries

Details

  • Analysis Components
    • Analysis component basics
    • File and Catalog definitions
      • FileInstance
      • FileTemplate
      • CatalogInstance
      • CatalogTemplate
    • Algorithm definitions
      • PZAlgorithm
      • Summarizer
      • Classifier
      • SpecSelection
      • ErrorModel
      • Reducer
      • Subsampler
        • Algorithm configurations
      • Selection
      • Subsample
    • Plot definitions
      • Plotter
      • PlotterList
    • Plotting dataset defintions
      • Dataset
      • DatasetList
      • Project
    • Plot Group definitions
      • PlotGroup
  • Factories
    • Factory basics
    • Specific Factories

Usage

  • rail_project CLI
    • rail-project
    • Inspecting configuration files
      • rail-project inspect
    • Reducing input catalogs
      • rail-project reduce
    • Subsampling data from catalogs
      • rail-project subsample
    • Building pipeline configuration files
      • rail-project build
    • Running pipelines
      • rail-project run
        • blending
        • estimate
        • estimate-recalib
        • estimate-sompz
        • evaluate
        • inform
        • inform-recalib
        • inform-somlike
        • inform-sompz
        • phot-errors
        • prepare
        • pz
        • somlike-recalib
        • spec-selection
        • tomography
        • truth-to-observed
  • rail_plot CLI
    • rail-plot
    • Inspecting plotting configuration files
      • rail-plot run
    • Extracting datasets from a RailProject
      • rail-plot extract-datasets
    • Combining plots with available datasets
    • Making plots
      • rail-plot run
  • Interactive Interface
    • Using RailProject interface
    • Using rail.projects.library interface
    • Using rail.plotting.control interface

Contributing

  • Contribution Overview
    • Contributing to RAIL
    • Contributing to rail_projects
    • Where to contribute:
    • Contribution workflow
      • Issue
      • Branch
        • Merge
        • Reviewing a PR
        • Naming conventions
    • Contribution Types
  • Fix an Issue
  • Adding a new RailDataset type
    • New RailDataset Example
  • Adding a new RailPlotter
    • New RailPlotter Example
  • Adding a new RailDatasetHolder
    • New RailDatasetHolder Example

Demonstrations

  • Example Notebooks
    • Using RailProject
      • Setup and teardown scripts to setup a test area
      • Load the test project
      • Inspect the test project
      • Run a data reduction algorithm on the test project data
      • Subsample the test project
      • Build all the pipelines for the “baseline” flavor
      • Generate the commands to run the “pz” pipeline in the “baseline” flavor for the “gold” selection
      • Generate the commands to run the “spec_selection” pipeline in the “baseline” flavor for the “gold” selection
    • Adding new flavors to a RailProject and using them
      • Import the usual suspects
      • Setup environment, and move to correct directory. This will also download the needed data files to run this example.
      • Build a very minimal project, with only the baseline flavor
      • Add a new flavor to the project
      • Make sure the flavor got added, and inspect it’s configuration.
      • Build the pipelines for the few flavor
      • Let’s see what the inputs for the new pz pipeline are
      • All set, run the pipeline
    • Using the rail.projects analysis component library
      • Setup and teardown scripts to setup a test area
      • Loading a library from a yaml file
      • Catalogs, Templates and Interpolats
      • Algorithm holders and algorithms
      • Named subsamples
      • Named selections
    • Making plots with the rail.plotting package
      • Setup and teardown scripts to setup a test area
      • import the plotting control and load the objects from the yaml file
      • Print the stuff that we have loaded
      • let’s have a look at the “PlotGroup” that we have loaded.

API

  • rail namespace
    • Subpackages
      • rail.plotting package
        • Submodules
      • rail.projects package
        • Submodules
RAIL_Projects
  • Search

© Copyright 2025, LSST DESC RAIL Contributors.

Built with Sphinx using a theme provided by Read the Docs.