BrutishGuy / pyfriends

Python implementation of the paper "PyFriends: The First Fully Generalized Friends-of-Friends Extragalactic Galaxy Group Finder", using a Friends-of-Friends (FoF) algorithm for galaxy group detection, augmented by graph theory approaches.
3 stars 1 forks source link

pyfriends

Python implementation of the paper "PyFriends: The First Fully Generalized Friends-of-Friends Extragalactic Galaxy Group Finder", using a Friends-of-Friends (FoF) algorithm for galaxy group detection, augmented by graph theory approaches.

A detailed description of the algorithm can be found in the paper above linked on ArXiv.org.

Installation

Download the repository through Git (For Windows, you can download Git Bash For Windows here).

git clone https://github.com/BrutishGuy/pyfriends.git

Data

Example data has been included in the ./data/ folder of this repository. It follows from Macri et al.

Execution

To execute the code, one must modify the config.text file to set necessary parameters for the run. These are already set to reasonable parameters.

Detailed explanation on these parameters will follow.

To run the code, simply execute the file Py2Friends.py through the command line or your favourite editor, ensuring your working directory is set to the repository directory, such that config.txt is in your working directory. Then, simply run

python ./src/Py2Friends.py

For any issues or feature requests, please log an issue on this Github repository.