Program to calculate and convert Tzolk’in/Maya calendar dates.
Project description
tzolkin-calendar - Converter for Maya Tzolk’in Dates
This program converts mayan Tzolk’in dates to gregorian dates and vice versa. If you want to know more about the maya calendar systems, see Links.
Information about the installation and usage you find at Installation and Usage
Table of Contents
- tzolkin-calendar - Converter for Maya Tzolk’in Dates
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
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
There are 2 Jupyter Notebooks online at Binder:
Interactive Tzolk’in converter:
The Usage of the module tzolkin-calendar in your code:
Prerequisites
You need Python, at least version 3.9 to be able to use tzolkin-calendar. You can download it from python.org.
To install the package, you need pip, see Installing pip.
Installation
Install the package using pip on a shell or command prompt:
python -m pip install tzolkin-calendar
More information about using pip you get at pip Quickstart
Usage
Using the Command-Line Client
Using the Jupyter Notebook
You can test it online at . You need to restart the kernel first by going to the menu and selecting Kernel->Restart & Run All to get the interactive sliders and input fields.
You can get Information about Jupyter Notebooks at the official site
Install Jupyter Notebook, Viola and ipywidgets
python -m pip install notebook voila ipywidgets
If you want to be able to open the Jupyter notebook files directly, install nbopen
.
python -m pip install nbopen
and add the extension to the list of extensions of your OS, so that you can double click
the .ipynb
files and Jupyter opens it.
On Linux:
python -m nbopen.install_xdg
On Windows:
python -m nbopen.install_win
For OS X, the installation is a bit more advanced, see nbopen
Download the Tzolk’in calendar notebook at Tzolk’in Calendar.ipynb
Open it in Jupyter Notebook and click the Voila
button.
You should now see something like:
Using the Python Module in Your Programs
See the second Jupyter Notebook about how to use the tzolkin-calendar module:
More information
Detailed information is available at the documentation website.
Contributing
Any help is welcome!
If you encounter a problem using tzolkin-calendar, a task it not as easy as you'd like it to be or you'd like something added to it: open an issue at GitHub.
Report Issues (Bugs and Feature Requests)
File a bug report at Github
Add a feature request at Github
Changing the Documentation and Source Code
If you'd like to contribute directly, e.g. better the documentation, add another language or
write some source code: fork tzolkin-calendar by clicking the Fork
-button in the upper right
corner of the GitHub project website.
Check out your fork of tzolkin-calendar using the URL from the Code
-button of your fork on Github.
The URL should be something like github.com/YOUR_USERNAME/tzolkin-calendar.git.
Details about how to fork a repository on Github are here
and set up the development environment using pipenv.
First, install pipenv if you don't already have it installed:
python -m pip install --upgrade pipenv
and install all needed packages to develop tzolkin-calender:
cd tzolkin-calendar
python -m pipenv install --dev
That command installs all packages in Pipfile
/Pipfile.lock
in the directory tzolkin-calender
,
the root directory of tzolkin-calendar.
More information about pipenv can be found at Pipenv.
Make your changes, push them to your forked repository and make a pull-request (e.g.
using the Pull request
-button above and right of GitHubs source file view).
Github Documentation on Collaborating with Issues and Pull Requests
See GitHub's documentation about how to contribute for details: Contributing at Github
License
Everything in tzolkin-calendar
is licensed under the MIT license, see file LICENSE
Badges
External Checks
Static Code Checks
Tests
Problem with Unicode output on GitHub's Windows 2019 Server: , see Issue #1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tzolkin_calendar-0.9.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae4309adf44d3bc2f2b8635cdbe611a6047221fe3c4cbbebe596c7df9862ae87 |
|
MD5 | 22d59505118bc779f86c8ffc8abf2630 |
|
BLAKE2b-256 | 93fc07e2f12787087ed0e60436758cd23e38b55bfdfb3339f89f2f2c14f6ec6a |