About Subaru PFS Survey Software

Subaru Prime Focus Spectrograph (PFS) is an optical and near-infrared multi-fiber spectrograph with 2394 science fibers which are distributed over the 1.3 degree-diameter field at the prime focus of the 8.2m Subaru telescope. PFS is being developed as a part of the Subaru Measurement of Images and Redshifts (SuMIRe) project where a large-sky imaging survey is ongoing with Hyper Suprime-Cam (HSC) and PFS will then conduct spectroscopic follow-up observation.
While PFS will be operated as a facility instrument of the Subaru telescope, a large survey program up to ∼300 nights over ∼5 years can be carried out in parallel in the framework of Subaru Strategic Program (SSP). Survey operation and data analysis are processed by three software packages: Survey Planning and Tracking (SPT), Exposure Targeting Software (ETS), and Data Reduction Pipeline (DRP), while Instrument Control software (ICS) is developed in pararell to hardware development separately from the other three packages. SPT manages a survey with updating the plan as it progresses taking into account inputs from observers and survey operators, and outputs from the data quality assessment and assurance. ETS provides assignments of the fibers to target objects at individual exposures taking into account various factors such as flexures of the telescope and the prime focus instrument of PFS, and the residual effects of atmospheric dispersion after corrections by Atmospheric Dispersion Corrector (ADC). DRP reduces the two-dimensional spectral images on the spectrograph detectors, transform them into one-dimensional calibrated spectra and measure spectroscopic parameters.
PFS data will be publicly available after a proprietary period (nominally 18 months) from observations via SMOKA (data archive operated by NAOJ). ETS is required for observers to prepare PFS observations and apply for Subaru open-use observing time. Meanwhile, the entire set of the Subaru PFS Survey Software packages are needed to coordinate and operate a large survey program.

Refer list of system announcements page for upcoming system modification or maintenance.

Project resources

2D DRP repositories (drp_stella, drp_stella_data, drp_instmodel, drp_instdata, obs_pfs; colorized in table following) are under GPLv3, all other repositories are under GPLv2.

Full list of available repositories is also available. Also refer documents on development management of the PFS project at doc repository of Subaru-PFS GitHub organization before contributing on developments.

Package JIRA Project Software modules' description GitHub code repositories
Project wide DAMD PFS Datamodel. This provides a standardized representation of all PFS data products. (This covers definition of data structures needed over the entire PFS project, such as file name schema, instrument on-site data storage structure, and detailed data format like FITS.) datamodel
INFRA PFS software development infrastructure. Documentation and configuration of support tools are handled in this project. Any infrastrucural request shall be covered here. doc, pfs_www_pipe
ICS INSTRM Instrument control software. This provides source codes for (almost all of) the instrument control and their configurations. (Some repositories are excluded from this eco-system for NDA or other reasons.) ics_*, tron_tron, tron_actorcore, pfs_instdata
DRP PIPE1D The 1D data reduction pipeline. This is based on AMAZED project by LAM. drp_1d, drp_1dpipe
GA1D The 1D data reduction pipeline dedicated to GA survey. drp_ga1d_abund
PIPE2D The 2D data reduction pipeline. The 2D pipeline receives raw images read out from the detectors and produces one-dimensional, flat-fielded, sky-subtracted, flux- and wavelength-calibrated spectra ready for scientific analyses. drp_stella (code)
drp_stella_data (data)
Wrapper for LSST/HSC pipeline (PFS-specific module in the HSC/LSST stack, to codify part of the inputs and outputs of the 2d pipeline) obs_pfs
SIM2D The 2D image simulator. This simulates raw images from the spectrograph detectors based on image characteritics from ray-tracing calculations of the optical model and detector characteristics. drp_instmodel (simulator)
drp_instdata (model)
ETS FIBERALLOC Fiber assignment software ets_fiber_assigner ets_networkflow
SPT SURVEY Exposure time calculator (ETC) spt_ExposureTimeCalculator
Survey operational database system spt_operational_database
Science Database SCIDB Survey science database and user interfaces for analysis. scidb_*
Observation Procedure OBSPROC Tools for observation processing and procedure

Development support services

In addition to repositories at Subaru-PFS organization at GitHub and pfspipe JIRA, the Subaru PFS Software team is using following services for our activity.

git-lfs

PFS software development uses Git LFS support on GitHub.com to store, track, and distribute large binary data files, such as FITS sample data file to prenset definitions or to run CI, or binary configuration file for firmware. Refer Git Large File Storage (LFS) web site for installation and usage.

In the PFS software development project, it is encouraged to follow recommendations listed below for maintenanceability and userbility such as to reduce network load and local storage space for normal users.

Slack

PFS slack is available for the participants of the PFS collaboration. To sign up Slack, please contact to the PFS Project Office. It is highly recommended to input real name (both First and Last) in a user profile page.

TravisCI

PFS is using TravisCI for code testing on some of the repositories.

If some repositories in the Subaru-PFS organization on GitHub are not listed at TravisCI, contact a repository owner of each repository or send a message to a corresponding mailing list at the pfspipe.ipmu.jp to propose using TravisCI.

back to top page