Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.82 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.82 KB

vidyut-chandas

A Sanskrit metrical classifier

vidyut-chandas identifies the meter in some piece of Sanskrit text.

This crate is under active development as part of the Ambuda project. If you enjoy our work and wish to contribute to it, we encourage you to join our Discord server, where you can meet other Sanskrit programmers and enthusiasts.

An online demo is available here.

vidyut-chandas is not a state-of-the-art solution, and you might consider exploring and using these other projects instead:

Overview

Sanskrit poetry uses a variety of meters, which specify the syllable patterns that a verse must follow. vidyut-chandas aims to provide a simple API for identifying the meter that a given verse uses.

vidyut-chandas is experimental code and follows in the footsteps of great projects like sanskritmetres and Skrutable.

Usage

(This API is unstable.)

We recommend using vidyut-chandas through our Chandas API:

use vidyut_chandas::{Chandas, MatchType, Vrtta};

let chandas = Chandas::from_file("/path/to/meters.tsv").unwrap();
let result = chandas.classify("mAtaH samastajagatAM maDukEwaBAreH");
assert_eq!(result.padya().as_ref().unwrap().name(), "vasantatilakA");
assert_eq!(result.match_type(), MatchType::Pada);