🐿️ squirrel

squirrel is a Python package for kinematic measurements, designed to simplify the fitting of multiple kinematic components at different redshifts, such as those found in the spectra of strongly lensed systems. Built on top of pPXF, squirrel offers quality-of-life features that streamline the kinematic fitting workflow, making it easier to analyze spectra with both single and multiple kinematic components.

Installation

To install squirrel from source, first clone the repository:

git clone https://github.com/ajshajib/squirrel.git
cd squirrel

Install the package and its dependencies:

pip install -r requirements.txt
pip install .

To install development dependencies (for testing, docs, etc.):

pip install -r requirements_dev.txt

You can now import and use squirrel in your Python scripts or notebooks.

For more details, see the documentation: https://squirrel.readthedocs.io/en/latest/

Citation

squirrel was developed in Shajib et al. (2026). Please cite this paper if you use squirrel in your research. If you also use the methodology of Knabel, Mozumdar, et al. (2025) to combine multiple template libraries, please cite that paper as well.

Contents

• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Deploying
• Credits
  • Development Lead
  • Contributors
• API
  • squirrel package
    • Submodules
    • squirrel.data module
    • squirrel.diagnostics module
    • squirrel.pipeline module
    • squirrel.template module
    • squirrel.util module
    • Module contents

Feedback

If you have any suggestions or questions about dolphin, feel free to email me at ajshajib@gmail.com.

If you encounter any errors or problems with dolphin, please let me know! Open an issue on the GitHub repository: ajshajib/dolphin.