Quickstart

This walkthrough introduces the core objects in a few minutes.

1) Import and register accessors

import pandas as pd
import jalali_pandas as jp

2) Create a JalaliTimestamp

from jalali_pandas import JalaliTimestamp

ts = JalaliTimestamp(1402, 6, 15)

3) Convert Gregorian → Jalali

gregorian = pd.Timestamp("2023-09-06")
jalali = jp.to_jalali_datetime(gregorian)

4) Build a Jalali date range

idx = jp.jalali_date_range("1402-01-01", periods=5, freq="D")

5) Use accessors

s = pd.Series(pd.date_range("2023-03-21", periods=3, freq="D"))
jalali_series = s.jalali.to_jalali()
months = jalali_series.jalali.month

6) Group by Jalali year

df = pd.DataFrame({"date": s, "value": [1, 2, 3]})
df["jdate"] = df["date"].jalali.to_jalali()
result = df.jalali.groupby("year").sum(numeric_only=True)

Next: go deeper in Core types.