Skip to content

Commit dd3b87c

Browse files
committed
docs: simplify description
1 parent 84f7189 commit dd3b87c

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,23 @@
88
Python package for astrometric plate solving
99
<br>
1010
<p align="center">
11-
<a href="https://github.com/lgrcia/twirl">
12-
<img src="https://img.shields.io/badge/github-lgrcia/twirl-blue.svg?style=flat" alt="github"/>
13-
</a>
14-
<a href="">
15-
<img src="https://img.shields.io/badge/license-MIT-lightgray.svg?style=flat" alt="license"/>
16-
</a>
17-
<a href="https://ui.adsabs.harvard.edu/abs/2022MNRAS.509.4817G">
18-
<img src="https://img.shields.io/badge/paper-gray.svg?style=flat" alt="paper"/>
19-
</a>
20-
<a href="https://twirl.readthedocs.io">
21-
<img src="https://img.shields.io/badge/documentation-black.svg?style=flat" alt="documentation"/>
22-
</a>
11+
<a href="https://github.com/lgrcia/twirl"><img src="https://img.shields.io/badge/github-lgrcia/twirl-blue.svg?style=flat" alt="github"/></a>
12+
<a href=""><img src="https://img.shields.io/badge/license-MIT-lightgray.svg?style=flat" alt="license"/></a>
13+
<a href="https://ui.adsabs.harvard.edu/abs/2022MNRAS.509.4817G"><img src="https://img.shields.io/badge/paper-gray.svg?style=flat" alt="paper"/></a>
14+
<a href="https://twirl.readthedocs.io"><img src="https://img.shields.io/badge/documentation-black.svg?style=flat" alt="documentation"/></a>
2315
</p>
2416
</p>
2517

26-
twirl is an astrometric plate solving package for Python. It is suited for cases where the Right Ascension and Declination (RA, dec) coordinates of the image center and the field of view is known, computing a World Coordinate System (WCS) based on GAIA reference stars.
18+
When the coordinates of an image (RA, dec) and the size of its field of view is approximately known, twirl can be used to compute a World Coordinate System (WCS) using GAIA reference stars.
2719

28-
twirl compute a WCS following these steps:
20+
<!-- twirl compute a WCS following these steps:
2921
3022
1. detection of stars in the image if not provided
3123
2. catalog query using image known center
3224
3. asterisms building and matching
3325
4. image recombination and wcs fit using astropy.wcs
3426
35-
Astersisms are made of 3 or 4 points. 4 points asterisms are built following Lang et al. 2009 while 3 points asterims are based on an original algorithm.
27+
Astersisms are made of 3 or 4 points. 4 points asterisms are built following Lang et al. 2009 while 3 points asterims are based on an original algorithm. -->
3628

3729
## Installation
3830

0 commit comments

Comments
 (0)