SpecpolFlow
SpecpolFlow: a new software package for spectropolarimetry using Python - Published in JOSS (2025)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Academic email domains
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Tools and tutorials for the analysis of stellar spectropolarimetric observations.
Basic Info
- Host: GitHub
- Owner: folsomcp
- License: gpl-2.0
- Language: Assembly
- Default Branch: main
- Homepage: https://folsomcp.github.io/specpolFlow/
- Size: 135 MB
Statistics
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 2
- Releases: 1
Metadata Files
README.md
Welcome to SpecpolFlow!
SpecpolFlow is live on PyPI at:
pip install specpolFlow
Installing SpecpolFlow will automatically install LSDpy.
The spectrum normalization tool NormPlot is an optional extra. It can be installed at the same time as SpecpolFlow using:
pip install specpolFlow[norm]
or NormPlot can be installed separately using:
pip install normPlot
Documentation is live on our website at: folsomcp.github.io/specpolFlow/
About SpecpolFlow
SpecpolFlow is a software package that provides a completely pythonic workflow for the analysis of spectropolarimetric observations of stellar sources (for example, data acquired from ESPaDOnS at CFHT, Narval at TBL, etc). It is designed to provide a single, user-friendly pipeline from telescope to science product.
SpecpolFlow incorporates tools for spectra normalization (Github: folsomcp/normPlot) and LSD profile calculation (Github: folsomcp/LSDpy). It also provides several supporting tools, including tools for developing and cleaning line masks, calculating the longitudinal magnetic field, and visualizing LSD profiles. These tools can be used through a fully documented Python API, or through a command line interface.
We also maintain a series of detailed tutorials, with examples of how to construct a flexible workflow from SpecpolFlow's tools for your specific needs (e.g., automation for very large datasets using tools like pandas = Python for Data Analysis). These tutorials are in the form of Jupyter Notebooks, which can also be run using collaborative platforms such as Google Colab.
The full documentation can be found here: folsomcp.github.io/specpolFlow/
Citing
If you use SpecpolFlow in your research, please cite our paper in the Journal of Open Source Software: Folsom, Erba, et al., (2025). SpecpolFlow: a new software package for spectropolarimetry using Python. Journal of Open Source Software, 10(111), 7891
Contact us!
You can reach the SpF Development Team at: specpolflow@gmail.com
SpF Development Team:
- Christi Erba (co-PI)
- Colin Folsom (co-PI)
- Veronique Petit
- Shaquann Seadrow
- Patrick Stanley
- Tali Natan
- Bonnie Zaire
Current Contributors: * Gregg Wade * Mary Oksala
Past Contributors: * Federico Villadiego Forero * DJ Meleney * Robin Moore * Dax Moraes * Marisol Catalan Olais
Logo:
The SpecpolFlow logo was created by the talented Tali Natan! Please contact the SpF team if you would like to use this graphic in a publication.
Owner
- Login: folsomcp
- Kind: user
- Repositories: 4
- Profile: https://github.com/folsomcp
JOSS Publication
SpecpolFlow: a new software package for spectropolarimetry using Python
Authors
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Department of Physics, California Lutheran University, 60 West Olsen Road, 91360, Thousand Oaks, CA, USA, LESIA, Observatoire de Paris, PSL University, CNRS, Sorbonne Université, Université Paris Cité, 5 place Jules Janssen, 92195 Meudon, France
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Department of Physics and Astronomy, Bartol Research Institute, University of Delaware, 19716, Newark, DE, USA
Tags
spectropolarimetry stellar magnetic fields astronomy software open source software astronomy data visualizationGitHub Events
Total
- Issues event: 3
- Watch event: 2
- Delete event: 1
- Issue comment event: 15
- Push event: 75
- Pull request event: 5
- Fork event: 1
- Create event: 2
Last Year
- Issues event: 3
- Watch event: 2
- Delete event: 1
- Issue comment event: 15
- Push event: 75
- Pull request event: 5
- Fork event: 1
- Create event: 2
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: about 8 hours
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.33
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: about 8 hours
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.33
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- gully (2)
Pull Request Authors
- warrickball (2)
- cerba (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 268 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 11
- Total maintainers: 1
pypi.org: specpolflow
Tools for the analysis of stellar spectropolarimetric data
- Homepage: https://github.com/folsomcp/specpolFlow
- Documentation: https://folsomcp.github.io/specpolFlow/
- License: gpl-2.0
-
Latest release: 1.0.0
published 8 months ago
Rankings
Maintainers (1)
pypi.org: normplot
An interactive tool for normalizing stellar spectra
- Homepage: https://github.com/folsomcp/normPlot/
- Documentation: https://folsomcp.github.io/specpolFlow/
- License: gpl-2.0
-
Latest release: 2.5.0
published 8 months ago
Rankings
Maintainers (1)
pypi.org: lsdpy
Least Squares Deconvolution for spectropolarimetric analysis
- Homepage: https://github.com/folsomcp/LSDpy
- Documentation: https://folsomcp.github.io/specpolFlow/
- License: gpl-2.0
-
Latest release: 1.0.0
published 8 months ago