GalaxyWitness

Package for topological data analysis of the big data. It is attempt to study distribution of galaxies in the universe via TDA. Based on GUDHI and Astropy

Requirements

1. Python 3.8+ and pip
2. git (for development)

OS X or Linux

Installation

For the best experience, use python virtual environment:

pip3 install virtualenv
virtualenv env (or python3 -m virtualenv galaxy-witness)
source ./env/bin/activate

Install this package from PyPI via pip install galaxywitness

Documentation

You can find our technical documentation here: Docs

For developers

Sphinx generates documentation for delelopers from sources in ./docs folder. HTML files of documentation are in ./docs/build/html and you can open it with browser. If you want to build documentation yourself:

cd docs
make html

or if you want to get .pdf with documentation:

cd docs
make latexpdf

Usage

To run just type:

python -m galaxywitness

In runtime the program will request you to choose file with your data. This file have to be in folder ./data

If you want to finish a work with package and deactivate virtual environment just type:

deactivate

Development

You can use python virtual environment and install dependencies manually:

Create and activate a virtual environment

This will create a new virtual environment called "galaxy-witness":

pip3 install virtualenv
virtualenv galaxy-witness (or python3 -m virtualenv galaxy-witness)
source ./galaxy-witness/bin/activate

This will clone the repository "GalaxyWitness" on your local machine, install dependencies and install this package 'galaxywitness':

git clone https://github.com/davidmiheev/GalaxyWitness
cd GalaxyWitness
pip install -r requirements.txt
python setup.py install

Or poetry package manager:

Poetry

git clone https://github.com/davidmiheev/GalaxyWitness
cd GalaxyWitness
poetry install

Uninstalling

For uninstalling (include dependencies and an virtual environment):

rm -r GalaxyWitness
rm -r galaxy-witness