https://github.com/adacs-australia/map21b-training-bpindor

Example software for use in the training project MAP21B for Bart Pindor

https://github.com/adacs-australia/map21b-training-bpindor

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: nature.com
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary

Keywords

python
Last synced: 7 months ago · JSON representation

Repository

Example software for use in the training project MAP21B for Bart Pindor

Basic Info
  • Host: GitHub
  • Owner: ADACS-Australia
  • License: gpl-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 35.2 KB
Statistics
  • Stars: 0
  • Watchers: 7
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Topics
python
Created over 4 years ago · Last pushed over 4 years ago

https://github.com/ADACS-Australia/MAP21B-Training-BPindor/blob/main/

# SkySim
This project was built in order to simulate source (star/galaxy/other) positions over an area of sky.

## Installing
This project relies only on python built-ins and the numpy library.
Use ```pip install -r requirements.txt``` if you don't yet meet these requirements.

## Usage
The main entry point for this project is `sim_catalog`:
```
./sim_catalog --help
usage: sim [-h] [--ref_ra REF_RA] [--ref_dec REF_DEC] [--radius RADIUS] [--n NSOURCES] [--out OUTFILE]

optional arguments:
  -h, --help         show this help message and exit

  --ref_ra REF_RA    Central/reference RA position HH:MM:SS.S format
  --ref_dec REF_DEC  Central/reference Dec position DD:MM:SS.S format
  --radius RADIUS    radius within which the new positions are generated (deg)
  --n NSOURCES       Number of positions to generate
  --out OUTFILE      Filename for saving output (csv format)
```

## Documentation
Documentation is currently just this file, and associated python docstrings.

## Author / Contribution
This project is developed by Dev One.
If you want to contribute to this project please create a fork and issue pull requests for new features or bug fixes.

## Credit
If you find this project to be useful in your academic work please cite the following paper:
[One, D. et al. Nature, 2021](https://nature.com)

Owner

  • Name: Astronomy Data and Computing Services
  • Login: ADACS-Australia
  • Kind: organization
  • Location: Australia

GitHub Events

Total
Last Year

Dependencies

environment.yml conda
  • anaconda
  • pip
  • python >=3.6
docs/requirements.txt pypi
  • myst-parser *
  • numpydoc *
  • pdoc *
  • sphinx *
  • sphinx-rtd-theme *
requirements.txt pypi
  • numpy >=1.19
test_requirements.txt pypi
  • pytest * test
  • pytest-cov * test