Metadata-Version: 2.1
Name: timesat
Version: 4.3.1
Summary: Python bindings to the TIMESAT Fortran core for analyzing satellite time-series data
Keywords: TIMESAT,remote sensing,phenology,time series analysis
Author: Lars Eklundh, Per Jönsson
Author-Email: Zhanzhang Cai <zhanzhang.cai@nateko.lu.se>
License: SPDX-License-Identifier: LicenseRef-Proprietary-TIMESAT-Research-Only
         
         TIMESAT Python Bindings License
         © 2025 Zhanzhang Cai, Lars Eklundh, and Per Jönsson
         
         This software provides Python bindings to the proprietary TIMESAT Fortran core.
         Use of this software is governed by the license terms set forth below.
         Redistribution, modification, or commercial use is prohibited except as explicitly
         permitted in this license agreement or by written consent of the authors.
         
         --------------------------------------------------------------------------------
         BEGIN LICENSE TERMS
         --------------------------------------------------------------------------------
         
         PROPRIETARY LICENSE AGREEMENT
         
         Copyright (c) 2026
         Zhanzhang Cai, Lars Eklundh, Per Jönsson.
         All rights reserved.
         
         --------------------------------------------------------------------------------
         1. License Grant
         --------------------------------------------------------------------------------
         
         You are granted a non-transferable, non-exclusive, revocable license
         to obtain, install, and use the precompiled binary libraries distributed
         with this package solely for non-commercial scientific research,
         academic teaching, and personal use.
         
         --------------------------------------------------------------------------------
         2. Restrictions
         --------------------------------------------------------------------------------
         
         You may NOT:
         
         - use the Library for any commercial purpose;
         - redistribute, sublicense, sell, lease, or otherwise transfer the Library
           or any derivative works to any third party, except as explicitly permitted
           below;
         - reverse engineer, decompile, disassemble, or otherwise attempt to derive
           the source code of the Library;
         - modify, adapt, translate, or create derivative works based on the Library.
         
         For the avoidance of doubt, redistribution of the unmodified Library is
         permitted solely through official distribution channels explicitly
         designated by the copyright holders (e.g., the official PyPI package).
         All other forms of redistribution are prohibited.
         
         --------------------------------------------------------------------------------
         3. Ownership
         --------------------------------------------------------------------------------
         
         The Library is and shall remain the exclusive property of
         Zhanzhang Cai, Lars Eklundh, and Per Jönsson.
         This license does not transfer to you any ownership rights.
         
         --------------------------------------------------------------------------------
         4. Commercial Use
         --------------------------------------------------------------------------------
         
         Commercial use of the Library is NOT permitted under this license.
         
         Any commercial use requires a separate written agreement with the
         copyright holders.
         
         --------------------------------------------------------------------------------
         5. Termination
         --------------------------------------------------------------------------------
         
         This license is effective until terminated.
         Violation of any of the above restrictions will result in automatic
         termination.
         Upon termination, you must immediately cease using the Library
         and destroy all copies in your possession.
         
         --------------------------------------------------------------------------------
         6. Disclaimer of Warranty
         --------------------------------------------------------------------------------
         
         The Library is provided "AS IS" without warranty of any kind,
         express or implied, including but not limited to warranties of
         merchantability or fitness for a particular purpose.
         You assume all risks associated with the use of the Library.
         
         --------------------------------------------------------------------------------
         7. Limitation of Liability
         --------------------------------------------------------------------------------
         
         In no event shall Zhanzhang Cai, Lars Eklundh, and Per Jönsson
         be liable for any damages (including, without limitation,
         lost profits, business interruption, or lost information)
         arising out of the use of or inability to use the Library.
         
         --------------------------------------------------------------------------------
         
         By using the Library, you agree to be bound by the terms of this license.
         
         --------------------------------------------------------------------------------
         END LICENSE TERMS
         --------------------------------------------------------------------------------
         
         If you use TIMESAT in your research, please cite the corresponding release
         on Zenodo:
         
         Cai, Z., Eklundh, L., & Jönsson, P. (2026).
         TIMESAT4: is a software package for analysing time-series of satellite
         sensor data (Version 4.2.x) [Computer software].
         Zenodo. https://doi.org/10.5281/zenodo.17369757
         
         If you use this software or the underlying TIMESAT algorithms in research,
         please cite the relevant TIMESAT publications as listed in the official
         repository.
         
         Contact:
         Dr. Zhanzhang Cai
         zhanzhang.cai@nateko.lu.se
         Department of Physical Geography and Ecosystem Science
         Lund University, Sweden
         https://www.nateko.lu.se
         
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Fortran
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: License :: Other/Proprietary License
Project-URL: Homepage, https://github.com/TIMESAT
Project-URL: ORCID, https://orcid.org/0000-0001-5883-4575
Requires-Python: >=3.10
Requires-Dist: numpy>=2.0
Description-Content-Type: text/markdown

# Timesat

> **License Notice**
>
> **TIMESAT is proprietary software.**
> It is freely available for **non-commercial scientific research,
> academic teaching, and personal use only**.
>
> **Commercial use requires a separate written agreement with the authors.**
>
> See the `LICENSE` and `NOTICE` files for full terms.

---

**Timesat** provides Python bindings for the [TIMESAT](https://github.com/TIMESAT) algorithms — a suite of routines for analyzing time-series of satellite remote sensing data.  
This package wraps the original **Fortran-based TIMESAT core** into a modern Python interface for convenient use in data analysis and research workflows.

---

## Features

- Native Python bindings for the **TIMESAT Fortran core**
- Cross-platform precompiled binaries (macOS Intel & ARM, Linux, Windows)
- Supports **Python 3.10–3.12**
- Compatible with **NumPy ≥ 2.0**
- Provides high performance through the compiled Fortran backend
- Simple API for fitting and extracting vegetation metrics from time-series data

---

## Installation

You can install the latest release directly from PyPI:

```bash
pip install timesat
```

> **Note**
>
> TIMESAT is proprietary software licensed for **non-commercial research,
> academic teaching, and personal use only**.
> Commercial use requires a separate written agreement.

---

## Version log

## 4.3.1 – Update output date format

YYDOY -> YYYYDOY

## 4.2.1 – License Change

Starting from version 4.2.1, TIMESAT is licensed under the
TIMESAT Research License.

This software is now licensed for non-commercial scientific research,
academic teaching, and personal use only.

Commercial use requires a separate written agreement with the authors.

Versions prior to v4.2.1 remain available under their original license.

### 4.1.12 – Debugged Windows parallel processing

### 4.1.11 – Added parallel processing

### 4.1.10 – Improved NoData Handling
Pixels whose land-cover class is not included in the SETTINGS table now receive a proper NoData value instead of zero.

### 4.1.9 – Performance release
- Build system updated to compile the Fortran core with high-optimization for improved runtime performance.
- Minor internal clean-ups to keep behaviour consistent across platforms.
- Note: Due to more aggressive optimization, very small floating-point differences (round-off level) may occur compared to earlier versions.

### 4.1.8 – Bugfixes and QA improvements
- **Fixed:** Issue related to handling of negative slopes in the time-series processing.
- **Added:** Switch for VPP (vegetation peak/phenology) calculation to give users more control over how metrics are derived.
- **Added:** `yfitqa` output for basic quality assessment of the fitted time-series.

---

## License
SPDX-License-Identifier: LicenseRef-Proprietary-TIMESAT-Research-Only

TIMESAT is proprietary software licensed under the
TIMESAT Research License.

It is freely available for non-commercial scientific research,
academic teaching, and personal use.

Commercial use is not permitted under this license and requires
a separate written agreement with the authors.

See the LICENSE file for the full license text.

---

## Citation

If you use **TIMESAT** in your research, please cite the corresponding release on Zenodo:

> Cai, Z., Eklundh, L., & Jönsson, P. (2025). *TIMESAT4:  is a software package for analysing time-series of satellite sensor data* (Version 4.1.x) [Computer software]. Zenodo.   
> [https://doi.org/10.5281/zenodo.17369757](https://doi.org/10.5281/zenodo.17369757)

If you use the underlying TIMESAT algorithms, please also cite the
relevant TIMESAT publications listed in the official repository.

---

## Contact and Licensing Inquiries

For licensing questions, including commercial use, please contact:

**Dr. Zhanzhang Cai**
Department of Physical Geography and Ecosystem Science
Lund University, Sweden
Email: zhanzhang.cai@mgeo.lu.se

https://www.nateko.lu.se

---

## Acknowledgments

- [TIMESAT](https://www.nateko.lu.se/TIMESAT) — Original analysis framework for satellite time-series data.  
- This project acknowledges the Swedish National Space Agency (SNSA), the European Environment Agency (EEA), and the European Space Agency (ESA) for their support and for providing access to satellite data and related resources that made this software possible.

---