Skip to content

alwin-m/ROS-Cycle-Project

Repository files navigation

ROS Cycle Logo

๐ŸŒธ ROS Cycle

Free Period Tracker & Menstrual Cycle Calendar

Track Your Cycle โ€” Privately, Transparently, and on Your Terms

License: MIT Open Source Privacy First No Cloud Platform

โœจ Features ยท ๐Ÿ“ How It Works ยท ๐Ÿš€ Getting Started ยท ๐Ÿ›ก๏ธ Privacy ยท ๐Ÿค Contribute


๐ŸŒบ What is ROS Cycle?

ROS Cycle is an open-source, privacy-first menstrual cycle tracker that runs entirely on your device. No accounts. No cloud. No telemetry. Just honest, math-backed predictions you can actually understand.

Unlike commercial trackers that hide their logic behind black-box algorithms, ROS Cycle is built on transparent, explainable mathematics โ€” so you always know how and why a prediction is made.

ROS Cycle is a tracker, not a diagnostic tool. Predictions are estimates based on your inputs, not medical advice.


โœจ Features

Feature Description
๐Ÿ—“๏ธ 12-Month Calendar View See your entire predicted cycle year at a glance
๐ŸŒก๏ธ Probabilistic Fertile Windows Gradient fertility bands instead of misleading binary labels
๐ŸŽฏ Ovulation Likelihood Peaks Gaussian-modeled peak estimates with uncertainty baked in
๐Ÿ“Š Confidence Indicators Know how reliable your predictions are, based on your cycle stability
๐Ÿ“„ Exportable PDF Reports Generate and save reports โ€” fully local, never uploaded
๐Ÿฉบ PCOD Symptom Checklist Optional, non-diagnostic symptom awareness tool
๐Ÿ”’ 100% On-Device Zero data transmission. Always.

๐Ÿ“ How It Works

ROS Cycle uses a two-layer mathematical model: a deterministic core anchored to your cycle data, layered with probabilistic reasoning to represent real biological uncertainty.

Inputs

Input Symbol Required
Last Menstrual Period start date Dโ‚€ โœ… Yes
Average cycle length (days) ฮผ_C โœ… Yes
Estimated cycle variability (ยฑ days) ฯƒ_C Optional
Average period length (days) P Optional

1. ๐Ÿ”ข Cycle Day Index

For any calendar date Dโ‚™, the cycle-relative day is:

CycleDay(Dโ‚™) = (Dโ‚™ โˆ’ Dโ‚€) mod ฮผ_C

Converts any absolute date into a repeating cycle position, anchoring all phase calculations.


2. ๐ŸŒฟ Phase Boundaries

Phase Range
๐Ÿ”ด Menstrual 0 โ‰ค d < P
๐ŸŸก Follicular P โ‰ค d < (ฮผ_C โˆ’ 14)
๐ŸŸข Ovulation Center d = (ฮผ_C โˆ’ 14)
๐Ÿ”ต Luteal (ฮผ_C โˆ’ 14) < d < ฮผ_C

3. ๐Ÿ“ˆ Probabilistic Ovulation Model

Ovulation is never certain. ROS Cycle models it with a Gaussian distribution:

P_ov(d) = exp( โˆ’(d โˆ’ (ฮผ_C โˆ’ 14))ยฒ / 2(ฯƒ_C + ฮด)ยฒ )
  • ฮด โ‰ˆ 1โ€“2 days of biological noise is always included
  • Confidence smoothly decreases the further a day is from the expected ovulation center
  • Output: a likelihood value between 0 and 1 per cycle day

4. ๐ŸŒˆ Fertility Probability Bands

Band Condition
๐Ÿ”ด High Fertility P_ov(d) > 0.6
๐ŸŸ  Medium Fertility 0.25 < P_ov(d) โ‰ค 0.6
๐ŸŸข Low Fertility P_ov(d) โ‰ค 0.25

No false certainty. Just gradients that reflect reality.


5. ๐Ÿงฎ Confidence Score

Confidence = 1 โˆ’ (ฯƒ_C / ฮผ_C)    [clamped to 0โ€“1]
Confidence Meaning
High Short, stable, predictable cycle
Medium Some variability present
Low High variability โ€” predictions less reliable

๐Ÿš€ Getting Started

# Clone the repository
git clone https://github.com/YOUR_USERNAME/ros-cycle.git

# Navigate into the project
cd ros-cycle

# Install dependencies
npm install

# Start the app locally
npm start

โšก Everything runs in your browser or on your machine. No backend, no server, no sign-up.


๐Ÿ›ก๏ธ Privacy First by Design

ROS Cycle was built around a core principle: your health data belongs to you, and only you.

  • โœ… All computation is local-only
  • โœ… No accounts required
  • โœ… No cloud storage, no sync, no telemetry
  • โœ… No behavioral tracking or background learning
  • โœ… Fully auditable open-source code
  • โœ… Predictable, deterministic outputs given the same inputs

๐Ÿฉบ PCOD Symptom Checker

ROS Cycle includes an optional symptom awareness checklist for common PCOD-related symptoms.

  • Summarizes symptom count
  • Encourages you to speak with a healthcare professional when appropriate
  • Does not influence cycle predictions
  • Does not perform any diagnosis

๐Ÿ“ค Output Summary

  • ๐Ÿ—“๏ธ 12-month cycle calendar
  • ๐ŸŽฏ Probability-informed fertile windows
  • ๐Ÿ“ˆ Ovulation likelihood peaks
  • ๐Ÿ“‰ Cycle confidence indicators
  • ๐Ÿ“„ Local-only exportable PDF reports

๐Ÿค Contributing

Contributions are warmly welcome! We especially value work that:

  • ๐Ÿ’ก Improves explainability of predictions
  • โ™ฟ Enhances accessibility
  • ๐Ÿ“Š Extends visualization clarity
  • ๐Ÿ”’ Preserves the privacy-first architecture

How to Contribute

# Fork the repo, then:
git checkout -b feature/your-feature-name
git commit -m "feat: describe your change"
git push origin feature/your-feature-name
# Open a Pull Request ๐ŸŽ‰

โš ๏ธ Feature proposals requiring cloud storage or opaque inference models will be carefully reviewed to ensure they align with ROS Cycle's core values.


โš ๏ธ Disclaimer

ROS Cycle is an educational and informational tool. Menstrual cycles are influenced by stress, illness, hormonal conditions, medications, and lifestyle factors. All predictions are estimates and may vary significantly.

Always consult a qualified healthcare professional for medical concerns.


๐Ÿ“„ License

MIT License โ€” free to use, modify, and distribute.

See LICENSE for full terms.


Made with ๐ŸŒธ for privacy, transparency, and cycle awareness.

ROS Cycle โ€” because your data should stay yours.

About

ROS Cycle is a minimal, web-based period tracking application designed to help young women track their menstrual cycles

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages