Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Repository
Velocity Structure Analysis Tool
Basic Info
- Host: GitHub
- Owner: r-j-arnold
- License: mit
- Language: Python
- Default Branch: master
- Size: 103 KB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Velocity Structure Analysis Tool (VSAT)
Description
VSAT is a tool for analysing velocity structure in star clusters/associations following the method described in Arnold & Goodwin (2018). We request that this paper is cited if this software is used to produce a research output (e.g. an academic paper). In short, for every possible pair of stars the distance between them (dr) and their velocity difference (dv) is calculated. Pairs are then sorted into dr bins. In each bin the mean dv of the pairs it contains is calculated. These mean dvs are plotted as a function of dr. This is the velocity structure.
To help investigate the velocity structure a second plot is produced. It shows a 2D projection of the stars. The stars are colour coded according to how often they appear in user-specified dr bins. Understanding which stars contribute most heavily to different parts of the velocity structure is often helpful for interpreting it. This is described in more detail in Arnold & Goodwin (2018).
This program is not dependent on the units of the data inputted, although pc and km/s are assumed and used to label figure axes.
Structure of the program
- Set parameters and flags
- Read in the data
- Calculate dr and dv for every pair of stars
- Sort pairs into dr bins and calculate the mean dv in each bin with errors
- Tidy up and get rid of any empty bins
- Correct the inflation of mean dv due to uncertainties (if desired)
- Make plots of the data- 1st plot: velocity structure
- 2nd plot: positions of the stars with the stars colour coded
How to run
- In parameters.py set the pathtodata variable to the path to the data file.
- In parameters.py set the error_flag to True or False depending on whether or not the velocity data has observational errors.
- In readdata.py fill in the readdata function to read in the data in the necessary format, which is described in comments.
- Run main.py from the command line like any other python script.
The user can set drstart and drend in parameters.py to specify which dr bins to colour code the second plot by.
This program was written using python version 2.7.13, and may encounter errors if run with later versions.
License information
VSAT has an MIT license, reflecting that it is free and users are welcome to modify it to better suit their needs or make improvements, but there is no warranty.
Contact information
For further information please contact Becky Arnold at r.j.arnold.uk@gmail.com.
Owner
- Name: Becky Arnold
- Login: r-j-arnold
- Kind: user
- Repositories: 1
- Profile: https://github.com/r-j-arnold
Astrophysics postdoc at the university of Keele
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Arnold" given-names: "Becky" orcid: "https://orcid.org/0000-0003-0355-0617" title: "VSAT" version: 1.0.0 date-released: 2021-09-08 doi: 10.5281/zenodo.5494150 url: "https://github.com/r-j-arnold/VSAT"