Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quatrope/pycf3
Python client for Cosmicflows-3 Distance–Velocity Calculator
https://github.com/quatrope/pycf3
client cosmicflows cosmology distance-calculation extragalactic galaxy python
Last synced: about 2 months ago
JSON representation
Python client for Cosmicflows-3 Distance–Velocity Calculator
- Host: GitHub
- URL: https://github.com/quatrope/pycf3
- Owner: quatrope
- License: other
- Created: 2019-09-21T22:41:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T03:23:32.000Z (about 2 years ago)
- Last Synced: 2024-10-10T09:33:05.692Z (2 months ago)
- Topics: client, cosmicflows, cosmology, distance-calculation, extragalactic, galaxy, python
- Language: Python
- Homepage:
- Size: 1.28 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pycf3 - Cosmicflows Galaxy Distance-Velocity Calculator client for Python
![image](https://raw.githubusercontent.com/quatrope/pycf3/master/res/logo_wbg.png)
----
[![QuatroPe](https://img.shields.io/badge/QuatroPe-Applications-1c5896)](https://quatrope.github.io/)
[![PyCF3 CI](https://github.com/quatrope/pycf3/actions/workflows/CI.yml/badge.svg)](https://github.com/quatrope/pycf3/actions/workflows/CI.yml)
[![ReadTheDocs.org](https://readthedocs.org/projects/pycf3/badge/?version=latest)](https://pycf3.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-BSD3-blue.svg)](https://www.tldrlegal.com/l/bsd3)
[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://badge.fury.io/py/pycf3)
[![PyPI](https://img.shields.io/pypi/v/pycf3)](https://pypi.org/project/pycf3/)## Description
pycf3 is a Python client for the
[Cosmicflows-3 Distance-Velocity Calculator](http://edd.ifa.hawaii.edu/CF3calculator/),
and [NAM Distance-Velocity Calculator](http://edd.ifa.hawaii.edu/NAMcalculator/)## Code Repository & Issues
https://github.com/quatrope/pycf3
## License
pycf3 is under [The BSD 3 License](https://www.tldrlegal.com/l/bsd3)
The BSD 3-clause license allows you almost unlimited freedom with the software
so long as you include the BSD copyright and license notice in it
(found in [Fulltext](https://raw.githubusercontent.com/quatrope/pycf3/master/LICENSE)).## Basic Install
Execute
```console
$ pip install pycf3
```## Development Install
Clone this repo and install with pip
```console
$ git clone https://github.com/quatrope/pycf3.git
$ cd pycf3
$ pip install -e .
```## Quick Usage
```pycon
>>> import pycf3
>>> cf3 = pycf3.CF3()
>>> result = cf3.calculate_distance(velocity=9000, glon=283, glat=75)
>>> print(result.observed_velocity_)
9000.0
>>> result.observed_distance_
array([136.90134347])
```For more information, read the [tutorial in the
documentation](https://pycf3.readthedocs.io).## Citation
- If you use the results of this work in your research or other applications,
please cite [Kourkchi et al. 2020, AJ, 159, 67](https://ui.adsabs.harvard.edu/abs/2020AJ....159...67K/abstract)
- Please acknowledge pycf3 in any research report or publication that
requires citation of any author\'s work. Our suggested acknowledgment
is:> The authors acknowledge the pycf3 project that contributed to the
> research reported here. \<\>### ABOUT THE DATA
All data exposed by pycf3 belongs to the project
> Cosmicflows-3 Distance-Velocity Calculator
> () Copyright (C) Cosmicflows
> Team - The Extragalactic Distance Database (EDD)Please cite:
> Kourkchi, E., Courtois, H. M., Graziani, R., Hoffman, Y., Pomarede,
> D., Shaya, E. J., & Tully, R. B. (2020). Cosmicflows-3: Two
> Distance--Velocity Calculators. The Astronomical Journal, 159(2), 67.#### BibText
```bib
@ARTICLE{2020AJ....159...67K,
author = {{Kourkchi}, Ehsan and {Courtois}, H{\'e}l{\`e}ne M. and
{Graziani}, Romain and {Hoffman}, Yehuda and {Pomar{\`e}de}, Daniel and
{Shaya}, Edward J. and {Tully}, R. Brent},
title = "{Cosmicflows-3: Two Distance-Velocity Calculators}",
journal = {\aj},
keywords = {590, 1146, 902, 1968, Astrophysics - Cosmology and
Nongalactic Astrophysics, Astrophysics - Astrophysics of Galaxies,
Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2020,
month = feb,
volume = {159},
number = {2},
eid = {67},
pages = {67},
doi = {10.3847/1538-3881/ab620e},
archivePrefix = {arXiv},
eprint = {1912.07214},
primaryClass = {astro-ph.CO},
adsurl = {https://ui.adsabs.harvard.edu/abs/2020AJ....159...67K},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```## Short video description
[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/yd3IaIsM4Bg/0.jpg)](https://www.youtube.com/watch?v=yd3IaIsM4Bg)
## Authors
- Juan BC - [[email protected]]([email protected])
- Bruno Sanchez
- Martin Beroiz
- Ehsan Kourkchi.[IATE](http://iate.oac.uncor.edu/) -
[CIFASIS](https://www.cifasis-conicet.gov.ar/)This project is part of the [QuatroPe](https://github.com/quatrope)
scientific tools.