Metadata-Version: 2.4
Name: ogle
Version: 0.1.0
Summary: ogle is a Python package helps users to manage and interact with OGLE (Optical Gravitational Lensing Experiment) data.
Author-email: Juan José Sánchez <pip@jjsm.science>
License: MIT License
        
        Copyright (c) 2026 Juan José Sánchez Medina
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://docs.jjsm.science/ogle
Project-URL: Repository, https://github.com/jj-sm/ogle
Project-URL: Issues, https://github.com/jj-sm/ogle/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.md
Requires-Dist: numpy
Requires-Dist: astropy
Requires-Dist: polars>=1.8.2
Requires-Dist: pandas>=2.0.3
Dynamic: license-file

# ogle 🔭

![PyPI - Version](https://img.shields.io/pypi/v/ogle?style=flat-square)
![PyPI - License](https://img.shields.io/pypi/l/ogle?style=flat-square)
[![Python Versions](https://img.shields.io/pypi/pyversions/ogle.svg?style=flat-square)](https://pypi.org/project/ogle/)

**ogle** is a Python package designed to simplify the management, retrieval, and interaction with **Optical Gravitational Lensing Experiment (OGLE)** data. It provides a streamlined interface for astronomers and researchers to handle light-curve data and lensing events.

---

## Features

* **Data Retrieval**: Automated utilities to fetch data from OGLE databases.
* **Format Conversion**: Seamlessly convert OGLE-specific data into `astropy` tables or `pandas` DataFrames.
* **Analysis Tools**: Functions for processing gravitational lensing light-curves.
* **Modern Workflow**: Full support for `uv`, `pip`, and type-hinting for high-performance research.


## Roadmap & Feature Status

> **Legend:**
> - ✅ **Completed**: Stable and available in the current version.
> - 🏗️ **In Progress**: Actively being developed in the `main` or `dev` branch.
> - 📅 **Planned**: On the radar for future releases.

### OGLE I

| Feature               |   Status   | Priority |
|:----------------------|:----------:|:--------:|
| **Multiple Features** | 📅 Planned |   Low    |

### OGLE II
| Feature                                   |     Status      | Priority |
|:------------------------------------------|:---------------:|:--------:|
| **Basic Data Fetching** (ASCII/Text)      |   ✅ Completed   |   High   |
| **Astropy/Pandas Integration**            | 🏗️ In Progress |   High   |
| **Interactive Light-Curve Plotting**      | 🏗️ In Progress |  Medium  |
| **Automated Event Classification**        |   📅 Planned    |  Medium  |
| **Cross-matching with Gaia DR3**          |   📅 Planned    |   Low    |
| **API Support for OGLE-IV Early Warning** |   📅 Planned    |   High   |

### OGLE III

| Feature               |   Status   | Priority |
|:----------------------|:----------:|:--------:|
| **Multiple Features** | 📅 Planned |   Low    |

### OGLE IV

| Feature               |   Status   | Priority |
|:----------------------|:----------:|:--------:|
| **Multiple Features** | 📅 Planned |   Low    |


## Installation

Install the stable version from [PyPI](https://pypi.org/project/ogle/):

```bash
pip install ogle
```

Or, if you prefer using [uv](https://github.com/astral-sh/uv):

```bash
uv add ogle
```

## Documentation and Usage

All the docs can be found at [docs.jjsm.science/ogle](https://docs.jjsm.science/ogle)

## Development

This project is built using the latest Python standards. If you are using this as a template or contributing:

1.  **Clone the repo**:
    ```bash
    git clone https://github.com/jj-sm/ogle.git
    cd ogle
    ```
2.  **Sync the environment (using uv)**:
    ```bash
    uv sync
    ```
3.  **Run the test suite**:
    ```bash
    uv run pytest
    ```

## License

This project is licensed under the **GNU General Public License v3 (GPLv3)**. This ensures the software remains free and open for the scientific community. See the [LICENSE](LICENSE) file for details.

## Contributing

Contributions make the scientific community stronger! 
1. Check out the [Contributing Guidelines](CONTRIBUTING.md).
2. Adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
3. Open a [Feature Request](https://github.com/jj-sm/ogle/issues) for new ideas.

## Citation

If you use **ogle** in your research or publications, please cite it using the metadata provided in the `CITATION.cff` file, or click the **"Cite this repository"** button in the GitHub sidebar.

---
*Maintained by [Juan José Sánchez Medina](mailto:pip@jjsm.science), BSc. Astronomy Student (Pontificia Universidad Católica de Chile)*
