Observe documentation
Program to observe and analyze data

Tool developed to assist persons who perform statistical tests on astrology.
Used to generate the graphics of https://g5.tig12.net/observe
Status : draft under development.

WARNING - current doumentation is outdated, does not correspond to the current state of the software.
This software has been developed and tested under Linux. A priori, it should also work under Windows and Macintosh.

Overview

Observe is based on a small generic mechanism which permits to invoke commands.
Commands are specified in YAML command files, located in directory commands/.
A command file contains the specifications of one or more commands.
Observe is used through the CLI (command line interface = console), and takes 2 parameters : 
php run-observe.php <command file> <command>
Ex: 
php run-observe.php insee/a00 prepare
will execute the command prepare described in file commands/insee/a00.yml

Installation

  1. Open a terminal and clone the repository on your local machine : 
    git clone https://github.com/tig12/observe
    (or download the code).
  2. Install php (version 8.0 or higher) on your machine.
  3. Install PECL extension "yaml".
    On debian-based systems : 
    sudo apt install php-yaml
    For other systems, see php manual.

Directory structure

The important files and directories are : 
observe/
    ├── commands/
    ├── docs/
    ├── src/
    ├── vendor/
    ├── config.yml.dist
    └── run-observe.php
In the rest of this doc, directory observe/ is called the root directory.
All the commands issued to run the program are done from the root directory.

The files you need to know about are :
  • run-observe.php is the entry point to use the program.
  • commands/ contains the the commands that you need to edit.
  • config.yml.dist needs to be copied (see below).

Configuration

Create a file config.yml by copying config.yml.dist : 
cp config.yml.dist config.yml
Configuration is only needed for some commands.

Usage

To check that the program works, open a terminal, go to observe root directory and type : 
php run-observe.php
WRONG USAGE - run-observes.php needs 2 arguments
-------                                                                                               
Usage : 
    php run-observe.php  
Example :
    php run-observe.php test/toto command1
-------
Possible values for argument1 : insee/a00, gauquelin/heredity
If a similar error message is displayed, it means that the installation was OK.

Command files

Program usage is based on command files
They are created by users ; they are used to describe what the program should do.
They are located in directory commands/.
They are written using YAML syntax.

Each command file contains description of commands.
One run of the program permits to execute one command ; usage of the program is then 
php run-observe.php <command file> <command>

About

Program started in december 2020 by Thierry Graff to compute a00 distributions, so Nick Kollerstrom can see if there are statistical anomalies.

TODO

  • NK, a00
    Any chance we could divide the big synastry group into thee parts? DC gave us the year of marriage. based on that we could have young couples (at marriage), medium couples and old couples.
    If the main synastry is Mars-Venus that signifies 'ardent passion' which should be stronger in the young married couples group.