asteroid_spinprops 1.0.0__tar.gz → 1.0.1__tar.gz

{asteroid_spinprops-1.0.0 → asteroid_spinprops-1.0.1}/PKG-INFO

@@ -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.1/README.md

@@ -0,0 +1,157 @@
+# asteroid-spinprops
+
+## Overview
+**asteroid-spinprops** is a Python package providing tools to fit SHG1G2 and SOCCA photometric models to sparse asteroid photometry.  
+It supports multiband modeling, residual analysis and shape, period and pole orientation estimation for small solar system objects.
+
+---
+
+## Installation
+Install the package via pip:
+
+```bash
+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
+import pandas as pd
+from asteroid_spinprops.ssolib import dataprep, periodest, modelfit
+
+# Suppose `pdf` is your initial asteroid DataFrame 
+# Ensure all columns are converted to the required single row format.
+pdf_s = pd.DataFrame({col: [np.array(pdf[col])] for col in pdf.columns})
+
+# Convert filter IDs to numeric
+unique_vals, inv = np.unique(pdf_s["cfid"].values[0], return_inverse=True)
+numeric_filter = inv + 1
+pdf_s["cfid"].values[0] = numeric_filter
+
+# --- Data cleaning and filtering ---
+clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928)
+clean_data, projection_rejects = dataprep.projection_filtering(data=clean_data)
+clean_data, iterative_rejects = dataprep.iterative_filtering(data=clean_data)
+
+# --- Fit SHG1G2 model ---
+shg1g2_params = modelfit.get_fit_params(
+    data=clean_data,
+    flavor="SHG1G2",
+)
+
+# Compute residuals for period analysis
+residuals_dataframe = modelfit.make_residuals_df(
+    clean_data, model_parameters=shg1g2_params
+)
+
+# --- Estimate rotation period ---
+p_in, k_val, p_rms, signal_peak, window_peak = periodest.get_multiband_period_estimate(
+    residuals_dataframe,
+    k_free=True,
+)
+
+# Assess period robustness via bootstrap resampling
+_, Nbs = periodest.perform_residual_resampling(
+    resid_df=residuals_dataframe,
+    p_min=0.03,
+    p_max=2,
+    k=int(k_val)
+)
+
+# --- Fit SSHG1G2 (spin + multiband) model ---
+SOCCA_params = modelfit.get_fit_params(
+    data=clean_data,
+    flavor="SSHG1G2",
+    shg1g2_constrained=True,
+    blind_scan=True,
+    period_in=p_in,
+)
+```
+
+## Models
+Photometric models from Carry et al.(2024) {2024A&A...687A..38C}
+and https://github.com/astrolabsoftware
+
+## Project status
+Under development

{asteroid_spinprops-1.0.0 → asteroid_spinprops-1.0.1}/pyproject.toml

@@ -1,20 +1,23 @@
 [project]
 name = "asteroid_spinprops"
-version = "1.0.0"
+version = "1.0.1"
 description = "Collection of tools used for fitting sHG1G2 and SOCCA photometric models to sparse asteroid photometry"
 authors = [
     {name = "Odysseas",email = "odysseas.xenos@proton.me"}
 ]
 license = {text = "MIT"}
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.9"
+
 dependencies = [
-    "astropy (==7.0.0)",
-    "fink-utils (==0.43.0)",
-    "nifty-ls (==1.1.0)",
-    "pandas (==2.3.3)",
-    "scipy (==1.16.2)",
-    "tqdm (==4.67.1)"
+    "astropy >=6.0",
+    "fink-utils >=0.47.0",
+    "nifty-ls >=1.1.0",
+    "pandas >=2.3",
+    "scipy >=1.10",
+    "tqdm >=4.67",
+    "sbpy >=0.5.0",
+    "pyarrow >=18.1" 
 ]
 
 [tool.poetry]
@@ -30,3 +33,4 @@ repository = "https://gitlab.com/odysseas_xenos/asteroid-spinprops"
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
+

asteroid_spinprops-1.0.0/README.md

@@ -1,76 +0,0 @@
-# asteroid-spinprops
-
-## Overview
-**asteroid-spinprops** is a Python package providing tools to fit SHG1G2 and SOCCA photometric models to sparse asteroid photometry.  
-It supports multiband modeling, residual analysis and shape, period and pole orientation estimation for small solar system objects.
-
----
-
-## Installation
-Install the package via pip:
-
-```bash
-pip install asteroid_spinprops
-```
-
-## Quick Start
-```python
-import numpy as np
-import pandas as pd
-from asteroid_spinprops.ssolib import dataprep, periodest, modelfit
-
-# Suppose `pdf` is your initial asteroid DataFrame 
-# Ensure all columns are converted to the required single row format.
-pdf_s = pd.DataFrame({col: [np.array(pdf[col])] for col in pdf.columns})
-
-# Convert filter IDs to numeric
-unique_vals, inv = np.unique(pdf_s["cfid"].values[0], return_inverse=True)
-numeric_filter = inv + 1
-pdf_s["cfid"].values[0] = numeric_filter
-
-# --- Data cleaning and filtering ---
-clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928)
-clean_data, projection_rejects = dataprep.projection_filtering(data=clean_data)
-clean_data, iterative_rejects = dataprep.iterative_filtering(data=clean_data)
-
-# --- Fit SHG1G2 model ---
-shg1g2_params = modelfit.get_fit_params(
-    data=clean_data,
-    flavor="SHG1G2",
-)
-
-# Compute residuals for period analysis
-residuals_dataframe = modelfit.make_residuals_df(
-    clean_data, model_parameters=shg1g2_params
-)
-
-# --- Estimate rotation period ---
-p_in, k_val, p_rms, signal_peak, window_peak = periodest.get_multiband_period_estimate(
-    residuals_dataframe,
-    k_free=True,
-)
-
-# Assess period robustness via bootstrap resampling
-_, Nbs = periodest.perform_residual_resampling(
-    resid_df=residuals_dataframe,
-    p_min=0.03,
-    p_max=2,
-    k=int(k_val)
-)
-
-# --- Fit SSHG1G2 (spin + multiband) model ---
-SOCCA_params = modelfit.get_fit_params(
-    data=clean_data,
-    flavor="SSHG1G2",
-    shg1g2_constrained=True,
-    blind_scan=True,
-    period_in=p_in,
-)
-```
-
-## Models
-Photometric models from Carry et al.(2024) {2024A&A...687A..38C}
-and https://github.com/astrolabsoftware
-
-## Project status
-Under development