Skip to content

Commit

Permalink
docs: document name resolvers
Browse files Browse the repository at this point in the history
  • Loading branch information
ManonMarchand committed Sep 16, 2024
1 parent 1079336 commit 9abd11e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
8 changes: 8 additions & 0 deletions examples/12_Planetary_surveys.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,14 @@
"source": [
"earth.target = \"Strasbourg\" # ipyaladin's home"
]
},
{
"cell_type": "markdown",
"id": "d042bb57",
"metadata": {},
"source": [
"Any name recognized by OpenStreetMaps will work."
]
}
],
"metadata": {
Expand Down
17 changes: 15 additions & 2 deletions src/ipyaladin/widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -434,8 +434,21 @@ def fov(self, fov: Union[float, Angle]) -> None:
def target(self) -> Union[SkyCoord, Tuple[float, float]]:
"""The target of the Aladin Lite widget.
It can be set with either a string, an `~astropy.coordinates.SkyCoord`, or
a tuple of angle-like objects.
The target can be provided as coordinates (either
`~astropy.coordinates.SkyCoord` or (`~astropy.coordinates.Longitude`,
`~astropy.coordinates.Latitude`)) or as a name (as a string).
The conversion from a name to coordinates does call different online services
depending on the base layer of the widget:
- for the sky: it uses CDS's
`Sesame <https://vizier.cds.unistra.fr/viz-bin/Sesame>`_ name resolver. This
looks first in SIMBAD, then in VizieR, and then in NED for the object's
coordinates.
- for Earth: it uses `Nominatim
<https://nominatim.openstreetmap.org/ui/search.html>`_, OpenStreetMap's
search bar
- for other solar system bodies: it calls the `Gazetteer of Planetary
Nomenclature <https://planetarynames.wr.usgs.gov/Nomenclature>`_
Returns
-------
Expand Down

0 comments on commit 9abd11e

Please sign in to comment.