asteroid_spinprops 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

{asteroid_spinprops-1.0.0.dist-info → asteroid_spinprops-1.0.1.dist-info}/METADATA

@@ -1,23 +1,27 @@
 Metadata-Version: 2.4
 Name: asteroid_spinprops
-Version: 1.0.0
+Version: 1.0.1
 Summary: Collection of tools used for fitting sHG1G2 and SOCCA photometric models to sparse asteroid photometry
 License: MIT
 Author: Odysseas
 Author-email: odysseas.xenos@proton.me
-Requires-Python: >=3.11
+Requires-Python: >=3.9
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: astropy (==7.0.0)
-Requires-Dist: fink-utils (==0.43.0)
-Requires-Dist: nifty-ls (==1.1.0)
-Requires-Dist: pandas (==2.3.3)
-Requires-Dist: scipy (==1.16.2)
-Requires-Dist: tqdm (==4.67.1)
+Requires-Dist: astropy (>=6.0)
+Requires-Dist: fink-utils (>=0.47.0)
+Requires-Dist: nifty-ls (>=1.1.0)
+Requires-Dist: pandas (>=2.3)
+Requires-Dist: pyarrow (>=18.1)
+Requires-Dist: sbpy (>=0.5.0)
+Requires-Dist: scipy (>=1.10)
+Requires-Dist: tqdm (>=4.67)
 Project-URL: Homepage, https://gitlab.com/odysseas_xenos/asteroid-spinprops
 Project-URL: Repository, https://gitlab.com/odysseas_xenos/asteroid-spinprops
 Description-Content-Type: text/markdown
@@ -37,6 +41,87 @@ Install the package via pip:
 pip install asteroid_spinprops
 ```
 
+## Input column requirements and preprocessing
+
+`asteroid_spinprops` expects photometric measurements to follow the **Fink alert schema**.  
+If your DataFrame uses different column names, they must be renamed to the standard format before analysis.
+
+The package maps common input columns to Fink-style fields:
+
+| Expected name | Description | 
+|---------------|-------------|
+| `cjd`         | Observation time (JD) |
+| `cmagpsf`     | PSF magnitude |
+| `csigmapsf`   | Magnitude uncertainty | 
+| `cfid`        | Filter identifier | 
+| `ra`          | Right ascension (deg) | 
+| `dec`         | Declination (deg) |
+| `Phase`       | Solar phase angle (deg) | 
+
+### Additional columns created during preprocessing
+
+The preprocessing step also adds the following fields:
+
+- **`cmred` — Reduced magnitude**
+
+  Computed from the heliocentric and observer-centric distances:
+
+
+$$
+\mathrm{cmred} = \mathrm{cmagpsf} - 5\log_{10}\!\left(\frac{r\,\Delta}{\mathrm{AU}^2}\right)
+$$  
+where `Obj_Sun_LTC_km` = \(r\) and `Range_LTC_km` = \(\Delta\).
+
+- **`jd_ltc` — Light-time–corrected Julian Date**
+
+  First converts MJD → JD (`+ 2400000.5`), then applies the correction
+
+  $$
+  JD_\mathrm{ltc} = JD - \frac{\Delta}{c},
+  $$    
+
+  using the one-way light-travel time in days.
+
+```python
+pdf.rename(
+    columns={
+        "Your_JD_column": "cjd",
+        "Your_magnitudes_column": "cmagpsf",
+        "Your_phase_angle_column": "Phase",
+        "Your_RA_column": "ra",
+        "Your_Dec_column": "dec",
+        "Your_magnitude_uncertainty_column": "csigmapsf",
+        "Your_filter_column": "cfid",
+    },
+    inplace=True,
+)
+
+# Add missing columns
+pdf["cmred"] = pdf["cmagpsf"] - 5 * np.log10(
+    pdf["Observer_SSO_distance_column"] * pdf["Sun_SSO_distance_column"] / (au**2)
+)
+
+# LT correction
+pdf["cjd"] = pdf["cjd"] + 2400000.5  # MJD to JD
+pdf["jd_ltc"] = pdf["cjd"] - pdf["Observer_SSO_distance_column"] / c_kmday  # light time correction
+
+```
+
+### Required inputs
+
+Your input DataFrame must therefore include:
+
+- time of observation  
+- PSF magnitude and uncertainty  
+- filter ID  
+- RA, Dec  
+- phase angle  
+- heliocentric distance (`Obj_Sun_LTC_km`)  
+- observer-centric distance (`Range_LTC_km`)
+
+The preprocessing step renames these fields to the Fink schema, computes reduced magnitudes, and applies the light-time correction to the observation timestamps.
+
+
 ## Quick Start
 ```python
 import numpy as np

{asteroid_spinprops-1.0.0.dist-info → asteroid_spinprops-1.0.1.dist-info}/RECORD

@@ -5,6 +5,6 @@ asteroid_spinprops/ssolib/modelfit.py,sha256=Kg5Qn0yU4wbfat9ZCvT9pYqSIo9toUm5kwh
 asteroid_spinprops/ssolib/periodest.py,sha256=XCBqsgPFcLFk-vreVmpYPjghJDyUyHSEeCULayqPRHg,13216
 asteroid_spinprops/ssolib/ssptools.py,sha256=DlSgYtXenztRAtEV9d4itzp5OZMjkbXkW2yZ_Qumu4U,4490
 asteroid_spinprops/ssolib/utils.py,sha256=BUeIP0DZ45tg5qAQML8LBM8Gbj1vn2d3PGzvgQvfq_I,11094
-asteroid_spinprops-1.0.0.dist-info/METADATA,sha256=LZvpOARV-nWnAkOnr5S097mzTbWufl7_qPS8zYxE6gw,3111
-asteroid_spinprops-1.0.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-asteroid_spinprops-1.0.0.dist-info/RECORD,,
+asteroid_spinprops-1.0.1.dist-info/METADATA,sha256=4aQ7NoSNXRB2HbMHw1AIjhNE3UZFLUL5CYV_QeQywnA,5635
+asteroid_spinprops-1.0.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+asteroid_spinprops-1.0.1.dist-info/RECORD,,