AstroKit

🌟 Current Version (BETA): 0.1.0

⚠️ AstroKit is currently under development.
Please use it with caution. Feedback and suggestions are very welcome — feel free to contact me at zhurui675@gmail.com. The first stable release (version 1.0.0) will be available soon (expected in late 2025).

🏁 Quick Start

AstroKit is a Python package for astronomical data analysis (hodgepodge 😁), developed by Rui Zhu. It provides:

1. Photometric data preprocessing — including photometric redshift estimation, extinction correction, and more.
2. Wrappers for classical astronomical software — such as GALFIT(M), STILTS, EAZY, and SExtractor.
3. A collection of useful functions developed for and inspired by my own research.
4. More features and documents are on the way!

✨ To install:

• step 1: pip install

pip install astrokit

• step 2: write your own config file
  create a new file named .astrokit_config.yaml in your home directory. Here is an example (also in the .astrokit_config_template.yaml file):

# software directory
PATH_SEX:  # SExtractor program file directory
  /opt/homebrew/Cellar/sextractor/2.28.0/share/sextractor
PATH_EAZY:  # EAZY program file directory
  /Users/rui/Applications/eazy-photoz

# Qucik Directory
PATH_DOWNLOAD:  # Default save file path
  /Users/rui/Downloads

# Project Tools Directory
PATH_PROJECT_TOOL:
  - <PATH_PROJECT1>
  - <PATH_PROJECT2>

# My Account and Password
Account_HSC: 
  username: <xxx>
  password: <xxx>

• step 3: Enjoy it!
  

import astrokit as ak

🔔 Tip: Because a lot of dependencies are required, it is recommended to use Miniconda to create a new environment and install AstroKit in it. All required packages are listed in the requirement.txt file.

# Create a new conda environment
conda create -n astro python=3.13
# Activate the environment
conda activate astro
# Install Required packages
pip install -r requirements.txt
# Install AstroKit
pip install astrokit

📖 Documentation

Read the full documentation at astrokit.readthedocs.io. The documentation is still under construction, and the API may change in the future.

📜 License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

📚 Citation

(Zenodo Software DOI)

@software{zhu_2025_15321580,
  author       = {Zhu, Rui},
  title        = {AstroKit: A Python Package for Astronomical Data
                   Analysis
                  },
  month        = may,
  year         = 2025,
  publisher    = {Zenodo},
  version      = {beta-0.0},
  doi          = {10.5281/zenodo.15321580},
  url          = {https://doi.org/10.5281/zenodo.15321580},
  swhid        = {swh:1:dir:db15360761629c93ac723f4566e63570dfbe1d75
                   ;origin=https://doi.org/10.5281/zenodo.15321579;vi
                   sit=swh:1:snp:d83768d3d6f61e42e4028e488e6212d39d77
                   0eea;anchor=swh:1:rel:54bf5502e35b15d3f73552ebb3bc
                   00e154356c18;path=/
                  },
}

🤝 Acknowledgements

This project makes use of code and Data from the following projects:

Data Cite

(astrokit.datasets.data)

• eazy_filters: Copied from the EAZY Code
• templates:
  1. lephare
  2. sdss

Code Cite

(astrokit.externals)

• HSC_pdr3/: Copied from hsc-gitlab
• sfdmap.py Copied from sfdmap2

(astrokit.ML)

• d2l.py: Modified from https://github.com/d2l-ai