A simple tool to manipulate and visualize UV/optical/NIR spectra for astronomical research.
Project description
specbox
A simple tool to manipulate and visualize UV/optical/NIR spectra for astronomical research.
Documentation
Online documentation is hosted on Read the Docs: https://specbox.readthedocs.io/en/latest/index.html
Citation
@software{fu_2026_18642758,
author = {Fu, Yuming},
title = {specbox: a simple tool to manipulate and visualize UV/optical/NIR spectra for astronomical research},
month = feb,
year = 2026,
publisher = {Zenodo},
version = {v1.0.0},
doi = {10.5281/zenodo.18642758},
url = {https://doi.org/10.5281/zenodo.18642758}
}
License
GPLv3. See LICENSE.
Installation
Dependencies
numpyscipyastropypyqtgraphPySide6specutilsmatplotlibpandaspyarroworfastparquet(optional, for reading parquet spectra tables)requestspillow(PIL)astroquery
It is recommended to set up an isolated environment before installing (choose either option A or B):
# Option A: Python venv
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
# Option B: conda
conda create -n specbox python=3.13 -y
conda activate specbox
python -m pip install --upgrade pip
Install the stable release from PyPI (recommended):
python -m pip install specbox
To install a pre-release/development version from source:
git clone https://github.com/rudolffu/specbox.git
cd specbox
python -m pip install .
Usage
Main classes and functions
The main classes and functions of specbox are:
basemodule.py:
SpecLAMOSTandSpecSDSS: classes to read and manipulate spectra from the LAMOST and SDSS surveys, respectively.SpecIRAF: class to read and manipulate spectra from the IRAF format.SpecEuclid1d: reader for Euclid combined 1D spectra, withMASK/good_masksupport and optionalgood_pixels_only=True.SpecPandasRow: generic reader for "table-of-spectra" files readable by pandas (parquet/csv/feather/...), where each row stores arrays (e.g. wavelength/flux/ivar).SpecSparcl: SPARCL parquet/table reader (e.g., for filesparcl_spectra.parquet). Common metadata columns includedata_release,targetid, and (optional)euclid_object_idfor Euclid overlay.
qtmodule.py:
PGSpecPlot: class to plot spectra in apyqtgraphplot.PGSpecPlotApp: class to create apyqtgraphplot with aQApplicationinstance.PGSpecPlotThread: class to create apyqtgraphplot in a thread.
Examples
Plotting a spectrum from the LAMOST survey
from specbox import SpecLAMOST
spec = SpecLAMOST('input_file.fits')
spec.plot()
# Smooth the spectrum
spec.smooth(5, 3, inplace=False)
Reading a SPARCL parquet spectra table (one row per spectrum)
from specbox.basemodule import SpecSparcl
# ext is a 1-based row index (ext=1 -> first row)
sp1 = SpecSparcl("sparcl_spectra.parquet", ext=1)
sp1.plot()
Run a PGSpecPlotThread for visual inspection of a list of spectra
from specbox import SpecLAMOST
from specbox.qtmodule import PGSpecPlotThread
from glob import glob
basepath = 'lamost_spec/fits_files/'
flist = glob(basepath+'*fits.gz')
flist.sort()
flist = flist[0:60]
a = PGSpecPlotThread(speclist=flist, SpecClass=SpecLAMOST, output_file='vi_output_test60.csv')
a.run()
Run a viewer over a multi-row parquet file (SPARCL/table-of-spectra)
from specbox.basemodule import SpecSparcl
from specbox.qtmodule import PGSpecPlotThreadEnhanced
viewer = PGSpecPlotThreadEnhanced(
spectra="sparcl_spectra.parquet",
SpecClass=SpecSparcl,
# Optional: overlay Euclid spectrum when the parquet has `euclid_object_id`
# and the Euclid combined FITS uses that ID as `EXTNAME`.
euclid_fits="COMBINED_EUCLID_SPECS.fits",
output_file="sparcl_vi_results.csv",
z_max=6.0,
load_history=True,
)
viewer.run()
Notes:
- Results CSV includes
targetidanddata_release(when available from the input table). - The enhanced viewer has a
Save PNGbutton that writes screenshots to./saved_pngs/.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file specbox-1.0.1.tar.gz.
File metadata
- Download URL: specbox-1.0.1.tar.gz
- Upload date:
- Size: 307.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b19d4e28b66c8d34da89374424649b2d171d228197056a30215908879060bf44
|
|
| MD5 |
7df54d010350484442ff8afd771fb8ca
|
|
| BLAKE2b-256 |
3ea13a2234235e8c5614145939010e326ddbedb6888428408301882e5233b4bc
|
Provenance
The following attestation bundles were made for specbox-1.0.1.tar.gz:
Publisher:
python-publish.yml on rudolffu/specbox
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
specbox-1.0.1.tar.gz -
Subject digest:
b19d4e28b66c8d34da89374424649b2d171d228197056a30215908879060bf44 - Sigstore transparency entry: 983303314
- Sigstore integration time:
-
Permalink:
rudolffu/specbox@261e19dc63a7ba446ca5a9a9532f3629f6569b7e -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/rudolffu
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@261e19dc63a7ba446ca5a9a9532f3629f6569b7e -
Trigger Event:
push
-
Statement type:
File details
Details for the file specbox-1.0.1-py3-none-any.whl.
File metadata
- Download URL: specbox-1.0.1-py3-none-any.whl
- Upload date:
- Size: 309.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b07948340347b5486f26af115979b40f8c1d4ae7129443d12ff6465f0101d285
|
|
| MD5 |
d5052459eabdb1da379136edc224c658
|
|
| BLAKE2b-256 |
403ab4219cbd53bedb2ff015f0e2ffe6681319f43a8af2109581d73d66582cf1
|
Provenance
The following attestation bundles were made for specbox-1.0.1-py3-none-any.whl:
Publisher:
python-publish.yml on rudolffu/specbox
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
specbox-1.0.1-py3-none-any.whl -
Subject digest:
b07948340347b5486f26af115979b40f8c1d4ae7129443d12ff6465f0101d285 - Sigstore transparency entry: 983303323
- Sigstore integration time:
-
Permalink:
rudolffu/specbox@261e19dc63a7ba446ca5a9a9532f3629f6569b7e -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/rudolffu
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@261e19dc63a7ba446ca5a9a9532f3629f6569b7e -
Trigger Event:
push
-
Statement type: