Skip to content

krishnakanthpps/jyotisha

 
 

Repository files navigation

JyotiSha tools and data

PyPI version Documentation Status Actions Status

Intro

A package to do various panchaanga (traditional vedic astronomical / astrological) calculations, produce calendars. It is backed by the pretty big adyatithi events database.

The code itself is capable of typical (amAnta, chitra-at-180 ayanAMsha, असङ्क्रान्तिमासोऽधिकः ) based calculation (which can be invoked via some shell scripts at karthik's panchaanga repo ) as well as the ancient but now uncommon tropical lunisolar system.

For a survey of similar software, see here.

Accuracy status

It is very important to note that this is an approximate panchaanga, automatically generated, without the careful oversight of learned scholars who have the depth of knowledge to resolve the exact dates for occurrences of different festivals. The best use of this panchaanga is as an approximate guide (95% of the events are also probably spot on) — when in doubt, consult only your own panchaanga!

Kartik has primarily restricted his testing to Chennai, Mumbai, London and Palo Alto.

Development status

  • Active
  • There is also a multiplatform-targetted Kotlin project at jyotisha-kotlin which merits attention."

For users

For detailed examples and help, please see individual module files - especially test files in this package.

Installation or upgrade:

  • Install the pyswisseph library specially as described below.
  • Install the jyotisha package
    • (Prefer this to get the latest code:)sudo pip install git+https://github.com/sanskrit-coders/jyotisha/@master -U
    • sudo pip install jyotisha -U
  • Web.

Usage

  • Please see the generated python sphynx docs in one of the following places (jyotisha.panchanga.scripts package docs may be particularly relevant):
  • REST API/ swagger web interface
    • Deployments at vedavaapi - obsolete and unmaintained as of 2020.
  • Command line usage - See this issue.

For contributors

Contributions welcome! Please see some basic comments (pertaining to the time format used internally, API layers required) in the base jyotisha package though.

Testing and autotesting

Every push to this repository SHOULD pass tests. We should have a rich, functional set of tests at various levels. Saves everyone's time.

You can see the status of failing tests and builds at https://github.com/sanskrit-coders/jyotisha/actions . PS: You can probably subscribe to get email notification on failed workflow runs as well - I'm getting these.

Contact

Have a problem or question? Please head to github.

Packaging

  • ~/.pypirc should have your pypi login credentials.
python setup.py bdist_wheel
twine upload dist/* --skip-existing

Test installation with one of these:

pip install . --target=./test_installation.local -U
pip install git+https://github.com/sanskrit-coders/jyotisha/@master --target=./test_installation.local -U

Document generation

Using pyswisseph

Pyswisseph is a thin wrapper around the C++ code.

Deployment

Credits

Sincere thanks to the creators of pyswisseph, without which I could not have attempted this. Many thanks are due to Ajit Krishnan for so clearly explaining the panchaanga process, and example festivals, which was sort of the inspiration for integrating a number of festivals. Many thanks to Saketha Nath for getting details of hundreds of festivals from obscure sources, and to the Vaidikasri magazine, which is another veritable treasure house of these festivals.

About

Python tools for the astronomical / astrological vedAnga of Indian hindus

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 78.5%
  • Python 21.4%
  • Shell 0.1%