Package for topological data analysis of the big data. It is attempt to study distribution of galaxies in the universe via TDA
Project description
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
- Python 3.8+ and pip
- 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)
. ./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)
. ./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/davidosx/GalaxyWitness
cd GalaxyWitness
pip install -r requirements.txt
python setup.py install
Or poetry package manager:
Poetry
git clone https://github.com/davidosx/GalaxyWitness
cd GalaxyWitness
poetry install
Uninstalling
For uninstalling (include dependencies and an virtual environment):
rm -r GalaxyWitness
rm -r galaxy-witness
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for galaxywitness-0.2.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db19980d0bc3d656b45b3365154c38a13e640e7c79ce999c85d575fcaa3f26eb |
|
MD5 | 5bb187158103d68c783654ae5e1bbacb |
|
BLAKE2b-256 | e7c4183a6f1d3f00cb0946bb2c16771e09e44467a9f656afdc557659c1c68184 |