README

Laravel Swiss Ephemeris

This laravel package perform queries to the Swiss Ephemeris executable and therefore relies on it using the same AGPL license. Using this package in your Laravel project means you'll need to use the same license. For commercial use, you'll need to purchase the corresponding license.

The aim of this project is to query ephemeris data to produce planetar positions in order to be used for purposes such as astronomy/astrology, planetary calendar, biodynamic calendar, etc.

In this software, only a fraction of the swiss ephemeris are used: you can query planets, Moon, and known asteroids from 1800 CE (AD) to 2399 CE (AD).

Development Roadmap

Check the next features in the development roadmap.

Installation

composer require marcoconsiglio/ephemeris

After installation run this command to publish the Swiss Ephemeris database and config file in your Laravel project.

php artisan vendor:publish --provider="MarcoConsiglio\Ephemeris\SwissEphemerisServiceProvider"

Remember to grant execution privileges to the swetest file, otherwise this software won't work. To do this, run the command

chmod u+x ./resources/swiss_ephemeris/swetest

To extend the ephemeris data, download the ephemeris files you wish and put them in the resources/swiss_ephemeris directory. If you don't know which files to download to extend the time range of the ephemeris, please refer to the description of the ephemerides.

Usage

First of all, to query ephemeris data you need to instantiate the 'LaravelSwissEphemeris' class. You need to pass a PointOfView class, if none is used, it defaults to Geocentric point of view.

use use Illuminate\Support\Facades\Config;
/** @var \MarcoConsiglio\Ephemeris\LaraverlSwissEphemeris $ephemeris */
/** @var \MarcoConsiglio\Ephemeris\Observer\Topocentric $pov */

$pov = new Topocentric(
    Config::get("ephemeris.latitude"), 
    Config::get("ephemeris.longitude"),
    Config::get("ephemeris.altitude")
);
$ephemeris = new LaravelSwissEphemeris(
    $pov,
    Config::get("ephemeris.timezone")
);

or instead, another PointOfView class:

use MarcoConsiglio\Ephemeris\Observer\Heliocentric;
/** @var \MarcoConsiglio\Ephemeris\LaraverlSwissEphemeris $ephemeris */

$ephemeris = new LaravelSwissEphemeris(new Heliocentric);

Check all available points of view for more info.

If something went wrong (e.g. like uncorrect permission for the files placed in the folder resources/swiss_ephemeris, outbound quering date, ect.) it will throw a MarcoConsiglio\Ephemeris\Exceptions\SwissEphemerisException exception. (This need to be tested and proved).

Premise

When using the word collection, it is meant that the class extends the Illuminate\Support\Collection, so you can treat it like any other collection.

API Documentation

For more information, see the API documentation at ./docs/html.

Index

Point of View

• Point of View

Datetime

• Swiss Ephemeris Datetime

Moon Ephemeris

• Synodic Rhythm
• Moon Periods
• Moon Phases
• Moon Anomalistic Rhythm
• Moon Draconic Rhythm