Skip to content

Epidemiological weeks calculation based on CDC (MMWR) and ISO week numbering systems

License

Notifications You must be signed in to change notification settings

dralshehri/epiweeks

Repository files navigation

EpiWeeks

A Python package for accurate epidemiological weeks calculation using the US CDC (MMWR) and ISO week numbering systems.

EpiWeeks provides reliable week calculations validated against CDC reference data, essential for disease surveillance, public health reporting, and epidemiological research.

Release Status Coverage Status PyPI Downloads PyPI Version Conda Version Package License Package DOI

✨ Features

  • Support for both the US CDC (MMWR) and ISO week numbering systems
  • Accurate and tested calculations validated against CDC reference data
  • Intuitive, clean, and easy-to-use interface
  • Calculation of the start and end dates of weeks
  • Iteration of year's weeks or week's dates
  • Rich comparison between weeks
  • Logical operations for weeks (addition, subtraction and containment)
  • Comprehensive input validation and error handling
  • Full type annotations and 100% test coverage
  • Zero runtime dependencies

📦 Installation

To install using uv, run:

uv add epiweeks

To install using pip, run:

pip install epiweeks

To install using conda, run:

conda install bioconda::epiweeks

🚀 Basic Usage

from epiweeks import Week, Year

week = Week(2019, 1)
print(week.enddate())
# 2019-01-05

for week in Year(2019).iterweeks():
    print(week.enddate())
# 2019-01-05
# 2019-01-12
# ...
# 2019-12-21
# 2019-12-28

📚 Documentation

Please refer to https://epiweeks.readthedocs.io for complete documentation on this package, which includes background information, usage examples, and API reference.

🤝 Contributing

If you're interested in contributing, please check out the Contributing guide for more information on how you can help!

📄 License

This project is licensed under the terms of the MIT license.

📝 Citation

If you plan to cite this project in your academic publication, please refer to https://doi.org/10.5281/zenodo.18171641 for citation information.

About

Epidemiological weeks calculation based on CDC (MMWR) and ISO week numbering systems

Topics

Resources

License

Contributing

Stars

Watchers

Forks