tzolkin-calendar

tzolkin-calendar is a program and Python package (to use in your own code) that converts Gregorian dates to Maya Tzolk’in dates and vice versa. If you want to know more about the Maya calendar systems, see Some General Links.

Information about installing and the different ways to use tzolkin-calendar you find under Installation and Usage.

If you want to convert and calculate with Tzolk’in dates in your own code, see Usage of tzolkin-calendar in Your Python Code.

Contributing has information about how to contribute to tzolkin-calendar, by filing bug reports or feature requests, to contributing source code, to adding documentation or translations or any other way you can help tzolkin-calendar.

There are 3 interactive Jupyter Notebooks online at Binder, were you can get a fast overview of the possibilities of tzolkin-calendar. To start the interactive program, click to Kernel -> Restart & Run All.

• Interactive gregorian to Tzolk’in converter and vice versa: Tzolk’in Calendar Notebook

• The command line program: Tzolk’in Calendar Command Line Client

• The usage of the module tzolkin-calendar in your code: Tzolk’in Calendar Python Package

Some General Links

Smithsonian Museo Nacional del Indígena Americano: Viviendo El Tiempo Maya

Website of the Smithsonian National Museum of the American Indian on Mayas Living Maya Time

Online general Maya (not only Tzolk’in) calendar converter: Maya Converter of the Smithsonian NMAI and Convertidor Al Calendario Maya Smithsonian NMIA

Mayan Glyphs and Unicode: Roadmap to the SMP and the PDF Updated List of Characters for Mayan Codices

Installation and Usage

• Installation
  • Prerequisites
    • Windows
    • Linux
    • Mac OS X
  • Installation
• Interactive Jupyter Notebook
  • Installation
• Tzolk’in Command Line Client
  • Converting Gregorian Dates to Tzolk’in Dates
  • Searching Tzolk’in Dates
  • Print all Tzolk’in Dates in a Tzolk’in Year
• License

Using in Your Code

• Usage of tzolkin-calendar in Your Python Code
  • Import the Module
  • The Tzolk’in Date Class Tzolkin
    • Convert Gregorian Dates to Tzolk’in Dates
    • Set Tzolk’in Dates
    • Search Gregorian Dates to a given Tzolk’in Date
    • Calculations using Tzolk’in Dates
• tzolkin_calendar Package
  • Submodules
  • tzolkin_calendar.tzolkin module
  • tzolkin_calendar.calculate module
  • tzolkin_calendar.main module

Contributing

• Contributing
  • Report Issues (Bugs and Feature Requests)
  • Forking the Repository
  • Setting the Development Environment
  • Github Documentation on Collaborating with Issues and Pull Requests
  • Common Tasks Developing tzolkin-calendar
    • Jupyter Notebooks
    • Changing and Generating Documentation
      • GitHub Documentation
    • Python Source Code
    • Tests
    • Local Source Code Linters
    • GitHub Workflows/Actions