swiss-ephemeris-0.3.1.0: Haskell bindings for the Swiss Ephemeris C library

Safe HaskellNone
LanguageHaskell2010

SwissEphemeris

Synopsis

Documentation

data Planet Source #

Instances
Enum Planet Source # 
Instance details

Defined in SwissEphemeris

Eq Planet Source # 
Instance details

Defined in SwissEphemeris

Methods

(==) :: Planet -> Planet -> Bool #

(/=) :: Planet -> Planet -> Bool #

Ord Planet Source # 
Instance details

Defined in SwissEphemeris

Show Planet Source # 
Instance details

Defined in SwissEphemeris

Generic Planet Source # 
Instance details

Defined in SwissEphemeris

Associated Types

type Rep Planet :: Type -> Type #

Methods

from :: Planet -> Rep Planet x #

to :: Rep Planet x -> Planet #

type Rep Planet Source # 
Instance details

Defined in SwissEphemeris

type Rep Planet = D1 (MetaData "Planet" "SwissEphemeris" "swiss-ephemeris-0.3.1.0-IBnQ6xV718GDveUO9b1h6" False) ((((C1 (MetaCons "Sun" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Moon" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Mercury" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Venus" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "Mars" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Jupiter" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Saturn" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Uranus" PrefixI False) (U1 :: Type -> Type)))) :+: (((C1 (MetaCons "Neptune" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Pluto" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "MeanNode" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TrueNode" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "MeanApog" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "OscuApog" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Earth" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Chiron" PrefixI False) (U1 :: Type -> Type)))))

data HouseSystem Source #

Instances
Enum HouseSystem Source # 
Instance details

Defined in SwissEphemeris

Eq HouseSystem Source # 
Instance details

Defined in SwissEphemeris

Ord HouseSystem Source # 
Instance details

Defined in SwissEphemeris

Show HouseSystem Source # 
Instance details

Defined in SwissEphemeris

Generic HouseSystem Source # 
Instance details

Defined in SwissEphemeris

Associated Types

type Rep HouseSystem :: Type -> Type #

type Rep HouseSystem Source # 
Instance details

Defined in SwissEphemeris

type Rep HouseSystem = D1 (MetaData "HouseSystem" "SwissEphemeris" "swiss-ephemeris-0.3.1.0-IBnQ6xV718GDveUO9b1h6" False) ((C1 (MetaCons "Placidus" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Koch" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Porphyrius" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "Regiomontanus" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Campanus" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Equal" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "WholeSign" PrefixI False) (U1 :: Type -> Type))))

data Coordinates Source #

Instances
Eq Coordinates Source # 
Instance details

Defined in SwissEphemeris

Ord Coordinates Source # 
Instance details

Defined in SwissEphemeris

Show Coordinates Source # 
Instance details

Defined in SwissEphemeris

Generic Coordinates Source # 
Instance details

Defined in SwissEphemeris

Associated Types

type Rep Coordinates :: Type -> Type #

type Rep Coordinates Source # 
Instance details

Defined in SwissEphemeris

data HouseCusps Source #

Constructors

HouseCusps 

Fields

Instances
Eq HouseCusps Source # 
Instance details

Defined in SwissEphemeris

Show HouseCusps Source # 
Instance details

Defined in SwissEphemeris

Generic HouseCusps Source # 
Instance details

Defined in SwissEphemeris

Associated Types

type Rep HouseCusps :: Type -> Type #

type Rep HouseCusps Source # 
Instance details

Defined in SwissEphemeris

data Angles Source #

Instances
Eq Angles Source # 
Instance details

Defined in SwissEphemeris

Methods

(==) :: Angles -> Angles -> Bool #

(/=) :: Angles -> Angles -> Bool #

Show Angles Source # 
Instance details

Defined in SwissEphemeris

Generic Angles Source # 
Instance details

Defined in SwissEphemeris

Associated Types

type Rep Angles :: Type -> Type #

Methods

from :: Angles -> Rep Angles x #

to :: Rep Angles x -> Angles #

type Rep Angles Source # 
Instance details

Defined in SwissEphemeris

defaultCoordinates :: Coordinates Source #

Default coordinates with all zeros -- when you don't care about/know the velocities, which would be the case for most inputs (though most outputs _will_ include them.) Usually you'll set only lat and lng (e.g. `defaultCoordinates{lat = 1.4, lng = 4.1}`) when using it as an input for another function.

mkCoordinates :: Coordinates Source #

Constructor alias of defaultCoordinates, since it's used a lot in that role.

julianDay :: Int -> Int -> Int -> Double -> JulianTime Source #

Given year, month and day as Int and a time as Double, return a single floating point number representing absolute Julian Time. The input date is assumed to be in Gregorian time. More info on this: https://www.astro.com/swisseph/swephprg.htm#_Toc46406824

setEphemeridesPath :: FilePath -> IO () Source #

Given a path to a directory, point the underlying ephemerides library to it. You only need to call this function to provide an explicit ephemerides path, if the environment variable SE_EPHE_PATH is set, it overrides this function.

setNoEphemeridesPath :: IO () Source #

Explicitly state that we don't want to set an ephemeris path, which will default to the built-in ephemeris, or use the directory in the SE_EPHE_PATH environment variable, if set.

closeEphemerides :: IO () Source #

Explicitly release all "cache" pointers and open files obtained by the C library.

withEphemerides :: FilePath -> IO a -> IO a Source #

Run a computation with a given ephemerides path open, and then close it. Note that the computation does _not_ receive the ephemerides, in keeping with the underlying library's side-effectful conventions.

withoutEphemerides :: IO a -> IO a Source #

Run a computation with no explicit ephemerides set, if the SE_EPHE_PATH environment variable is set, that will be used. If not, it'll fall back to in-memory data.

calculateCoordinates :: JulianTime -> Planet -> IO (Either String Coordinates) Source #

Given a decimal representation of Julian Time (see julianDay), and a Planet, returns either the position of that planet at the given time, if available in the ephemeris, or an error. This function is in IO because it _may_ allocate memory/read data beyond its scope, when using ephemeris data.

calculateCuspsLenient :: JulianTime -> Coordinates -> HouseSystem -> IO CuspsCalculation Source #

Given a decimal representation of Julian Time (see julianDay), a set of Coordinates (see mkCoordinates,) and a HouseSystem (most applications use Placidus,) return a CuspsCalculation with all 12 house cusps in that system, and other relevant Angles. Notice that certain systems, like Placidus and Koch, are very likely to fail close to the polar circles; in this and other edge cases, the calculation returns cusps in the Porphyrius system. This function is in IO because it _may_ allocate memory/read data beyond its scope, when using ephemeris data.

calculateCuspsStrict :: JulianTime -> Coordinates -> HouseSystem -> IO (Either String CuspsCalculation) Source #

Unlike calculateCuspsLenient, return a Left value if the required house system couldn't be used to perform the calculations.