ogle 0.1.0

ogle is a Python package helps users to manage and interact with OGLE (Optical Gravitational Lensing Experiment) data.

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:

pip install ogle

Or, if you prefer using uv:

uv add ogle

Documentation and Usage

All the docs can be found at 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:

   git clone https://github.com/jj-sm/ogle.git
   cd ogle
   

2. Sync the environment (using uv):

   uv sync
   

3. Run the test suite:

   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 file for details.

Contributing

Contributions make the scientific community stronger!

1. Check out the Contributing Guidelines.
2. Adhere to the Code of Conduct.
3. Open a Feature Request 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, BSc. Astronomy Student (Pontificia Universidad Católica de Chile)