https://github.com/drewsonne/maya-dates
Javascript Library to handle Maya date conversions
https://github.com/drewsonne/maya-dates
archaeology digital-humanities mayan-calendar mayan-language mesoamerica mesoamerican
Last synced: 4 months ago
JSON representation
Javascript Library to handle Maya date conversions
- Host: GitHub
- URL: https://github.com/drewsonne/maya-dates
- Owner: drewsonne
- Created: 2019-12-22T18:28:55.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-04T05:30:00.000Z (over 2 years ago)
- Last Synced: 2025-04-10T14:51:15.365Z (6 months ago)
- Topics: archaeology, digital-humanities, mayan-calendar, mayan-language, mesoamerica, mesoamerican
- Language: TypeScript
- Homepage: https://drewsonne.github.io/maya-dates/
- Size: 4.57 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @drewsonne/maya-dates
A typescript library for interacting with and modifying both the Maya Long Count (LC)
and Calendar Round (CR) dates.
# Quickstart
```sh
npm install [-g] @drewsonne/maya-dates
```
```typescript
import LongCountFactory from "@drewsonne/maya-dates/lib/factory/long-count";
// Long Count from Initial Series on east side of Stele E, Quirigua
let lc = new LongCountFactory().parse('9.17.0.0.0');
console.log(`${lc.buildFullDate()}`);
```
This should print `13 Ajaw 18 Kumk'u 9.17. 0. 0. 0`.
## Instructions
Most implementations will consist of creating a fullDate, and passing it to an operation.
### Date Creation
Creating a fullDate can be done either by:
- using a factory class ([LongCountFactory](https://drewsonne.github.io/maya-dates/class/src/factory/long-count.js~LongCountFactory.html),
[CalendarRoundFactory](https://drewsonne.github.io/maya-dates/class/src/factory/calendar-round.js~CalendarRoundFactory.html),
[FullDateFactory](https://drewsonne.github.io/maya-dates/class/src/factory/full-date.js~FullDateFactory.html))
and calling its `parse(raw_string)` function, where `raw_string` is a LC, CR,
or CR and LC combination encoded as a string. To specify missing values in a
fullDate, using `*`. For example,
```typescript
import {Wildcard, isWildcard} from "@drewsonne/maya-dates/lib/wildcard"
import LongCountFactory from "@drewsonne/maya-dates/lib/factory/long-count";
import CalendarRoundFactory from "@drewsonne/maya-dates/lib/factory/calendar-round";
import FullDateFactory from "@drewsonne/maya-dates/lib/factory/full-date";
const wildcard = new Wildcard();
const partial_lc = new LongCountFactory().parse('9.17.0.0.*');
const partial_cr = new CalendarRoundFactory().parse('13 Ajaw * Kumk\'u');
const partial_date = new FullDateFactory().parse('13 Ajaw * Kumk\'u 9.17.0.0.*');
console.log(`LC: ${isWildcard(partial_lc.kIn)}`);
console.log(`CR: ${isWildcard(partial_cr.haab.coeff)}`);
console.log(`Full Date: ${isWildcard(partial_date.lc.kIn)}`);
```
- passing explicit values into a model factory or class ([getCalendarRound](https://drewsonne.github.io/maya-dates/docs/function/index.html#static-function-getCalendarRound),
[LongCount](https://drewsonne.github.io/maya-dates/class/src/lc/long-count.js~LongCount.html),
[FullDate](https://drewsonne.github.io/maya-dates/docs/class/src/full-date.js~FullDate.html)).
```javascript
import {getCalendarRound} from "@drewsonne/maya-dates/lib/cr/calendar-round";
import {getHaab} from "@drewsonne/maya-dates/lib/cr/haab";
import {getTzolkin} from "@drewsonne/maya-dates/lib/cr/tzolkin";
import {getHaabMonth} from "@drewsonne/maya-dates/lib/cr/component/haabMonth";
import {getTzolkinDay} from "@drewsonne/maya-dates/lib/cr/component/tzolkinDay";
import {coefficientParser as _} from "@drewsonne/maya-dates/lib/cr/component/coefficient"
import {FullDate} from "@drewsonne/maya-dates/lib/full-date"
import {LongCount} from "@drewsonne/maya-dates/lib/lc/long-count"
const calendarRound = getCalendarRound(
getTzolkin(_(13), getTzolkinDay('Ajaw')),
getHaab(_(18), getHaabMonth('Kumk\'u'))
);
const lc = new LongCount(0, 0, 0, 17, 9);
const fullDate = new FullDate(calendarRound, lc);
console.log(`${lc}`);
console.log(`${calendarRound}`);
console.log(`${fullDate}`);
```
### Operations
Once a full date object has been created, you can either add an integer to a fullDate
using `shift(number)`, or filling in missing values in wildcards. The
[`operations`](https://drewsonne.github.io/maya-dates/identifiers.html#operations)
namespace provides operators to expand a fullDate with a wildcard into all possible
values for dates matching that wildcard pattern.
## Documentation
Full documentation and reference can be found at
[https://drewsonne.github.io/maya-dates/](https://drewsonne.github.io/maya-dates/).