Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions .claude/skills/docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,28 @@ discrepancy.

The manual is written warmly and directly, but it stays measured and
professional — clear guidance from someone who knows the instrument well, not
breezy chat. Match it:
breezy chat. It is also **lean**: the reader is usually at the eyepiece in the
dark, so every sentence earns its place. Keep the warmth, cut the padding. Match
it:

- **Talk to the reader as "you."** "You'll then see the Main Menu appear."
- **Be warm but measured.** Keep the tone calm and confident rather than
breathless. Reserve exclamation points for the rare genuinely delightful
moment and prefer plain, declarative sentences the rest of the time.
- **Be succinct.** Say it once, in as few words as carry the meaning. Cut
throat-clearing ("In order to…", "You should note that…"), redundant
restatement, and hedging. Favour the active voice and concrete verbs. When a
procedure runs to more than two or three ordered steps, prefer a numbered list
over a chain of "To begin… Next… Once you have…" paragraphs.
- **Write complete sentences; don't open with a conjunction.** Never begin a
sentence with "And" — join the thought to the sentence before it, or rephrase.
The same goes for opening with "But" or "So."
- **Explain the *why*, not just the *what*.** The existing docs constantly say
things like "This helps save battery power and can prevent glare at the
eyepiece." A reader who understands the reason trusts the instruction.
- **Explain the *why*, but compress it.** A reader who understands the reason
trusts the instruction, so keep the *why* — but state it in a clause, not a
paragraph. "The PiFinder dims the screen after a while to save battery and
prevent glare" earns its keep; a three-sentence aside reassuring the reader
that this is normal usually does not. When a caveat genuinely needs more room,
put it in a `.. note::` rather than swelling the main flow.
- **Plain language over jargon.** When a technical term is unavoidable (plate
solving, alt/az), define it in passing the first time, the way the quick start
glosses "plate solving" as taking continuous pictures and comparing them.
Expand Down
359 changes: 148 additions & 211 deletions docs/source/build_guide.rst

Large diffs are not rendered by default.

53 changes: 24 additions & 29 deletions docs/source/catalogs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,22 @@
PiFinder™ Catalogs
===================

The PiFinder comes with a number of astronomical catalogs which can be searched and filtered.
Each has a short catalog code displayed on the PiFinder UI. You can select which catalogs
are active via the :ref:`Filters<user_guide:filters>`
menu.
The PiFinder ships with several astronomical catalogs you can search and filter.
Each carries a short catalog code shown on the UI. Choose which catalogs are
active in the :ref:`Filters<user_guide:filters>` menu.

A few of these catalogs — the Washington Double Star catalog especially — hold far too many
entries to scroll through. For those, use **Name Search** to jump straight to an object by
its designation, or sort a list by **Nearest** to surface the objects closest to where your
scope is currently pointed.
A few catalogs — the Washington Double Star catalog especially — hold far too many
entries to scroll. For those, use **Name Search** to jump to an object by its
designation, or sort by **Nearest** to surface the objects closest to where your
scope is pointed.

Abl
----
The Abell Catalog of Planetary Nebulae (1966 by George O. Abell) contains 79 entries confirmed to be planetary nebulae.
The Abell Catalog of Planetary Nebulae (George O. Abell, 1966): 79 confirmed planetary nebulae.

Arp
----
Atlas of Peculiar Galaxies (Arp 1966)
Select galaxies with interest morphology. See `Wikipedia - Atlas of Peculiar Galaxies <https://en.wikipedia.org/wiki/Atlas_of_Peculiar_Galaxies>`_
Atlas of Peculiar Galaxies (Arp 1966). Galaxies with unusual morphology. See `Wikipedia - Atlas of Peculiar Galaxies <https://en.wikipedia.org/wiki/Atlas_of_Peculiar_Galaxies>`_

B
----
Expand All @@ -31,20 +29,19 @@ Caldwell catalog

Col
----------
The Collinder catalogue has 471 open clusters compiled by Swedish astronomer Per Collinder.
471 open clusters compiled by Swedish astronomer Per Collinder.

EGC
----
Catalog of Extra-Galactic Globular Clusters. This catalog features globulars associated with nearby galaxies and are visible through modest amateur telescopes, mostly in Andromeda.
Catalog of Extra-Galactic Globular Clusters: globulars associated with nearby galaxies, mostly in Andromeda, visible through modest amateur telescopes.

H
----------
The Herschel 400 catalogue is a subset of William Herschel's original Catalogue of Nebulae and Clusters of Stars, selected in response to a letter in Sky and Telescope.
A subset of William Herschel's original Catalogue of Nebulae and Clusters of Stars, selected in response to a letter in Sky and Telescope.

Harris
-------
Globular Clusters in the Milky Way (Harris, 1997)
This catalog compiled was by William E. Harris and used by permisson.
Globular Clusters in the Milky Way (Harris, 1997). Compiled by William E. Harris, used by permission.

IC
----------
Expand All @@ -60,46 +57,44 @@ Messier catalog

NGC
----------
NGC 2000.0, The Complete New General Catalogue and Index Catalogue of Nebulae and Star Clusters by J.L.E. Dreyer Sinnott, R.W. (edited by)
NGC 2000.0, The Complete New General Catalogue and Index Catalogue of Nebulae and Star Clusters by J.L.E. Dreyer (edited by R.W. Sinnott).

RDS
----
the RASC Double Stars Observing Program.
The 110 double star targets are visible from the northern hemisphere in many constellations.
The RASC Double Stars Observing Program: 110 double-star targets visible from the northern hemisphere across many constellations.

SaA
----------
Saguaro Astronomy Club Asterisms Database Version 3.2

SaM
----
Saguaro Astronomy Club Double Star Database Version 4.0
2162 double stars.
Saguaro Astronomy Club Double Star Database Version 4.0: 2,162 double stars.

SaR
----
SAC Red Stars Database Version 2.0

Sh2
----
The Sharpless catalog is a list of 313 H II regions (emission nebulae) intended to be comprehensive north of declination −27°.
313 H II regions (emission nebulae), comprehensive north of declination −27°.

Str
----
A catalog of named bright stars. Especially useful for aligning GoTo scopes.
Named bright stars. Especially useful for aligning GoTo scopes.

Ta2
----------
The TAAS 200 deep sky astronomical observing list designed for the intermediate observer, and includes the best 200 non Messier objects easily visible from central New Mexico, (objects north of declination -48).
The TAAS 200 deep-sky observing list for the intermediate observer: the best 200 non-Messier objects easily visible from central New Mexico (north of declination −48°).

TLK
----
TLK's hand-picked list of interesting variable stars visible from the northern hemisphere.

WDS
----
The Washington Double Star Catalog — the PiFinder includes over 130,000 double and multiple
star pairs from it. Because the full list is far too long to scroll, find a pair with
**Name Search** (type its WDS designation) or sort the list by **Nearest** to bring up the
doubles closest to where your scope is pointing.
For more information on WDS, please see: `https://www.astro.gsu.edu/wds/ <https://www.astro.gsu.edu/wds/>`_
The PiFinder includes over 130,000 double and multiple star pairs from the
Washington Double Star Catalog. The full list is far too long to scroll, so find
a pair with **Name Search** (type its WDS designation) or sort by **Nearest** to
bring up the doubles closest to where your scope is pointing.
For more on WDS, see `https://www.astro.gsu.edu/wds/ <https://www.astro.gsu.edu/wds/>`_
120 changes: 58 additions & 62 deletions docs/source/equipment.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,40 @@
Equipment
=========

The PiFinder can keep track of the telescopes and eyepieces you observe with.
Telling it about your gear is optional, but it unlocks several conveniences:
it works out the magnification and true field of view for any
telescope-and-eyepiece pairing, it sizes and orients the survey images on the
:ref:`user_guide:object details` screen to match what you actually see at the
eyepiece, and it lets the push-to arrows follow the way your particular setup
moves.

You manage your equipment from two places. The :ref:`user_guide:web interface`
is where you add and edit telescopes and eyepieces, and the Equipment screen on
the PiFinder itself is where you pick which ones are active for tonight's
session.
The PiFinder can track the telescopes and eyepieces you observe with. Telling
it about your gear is optional, but it unlocks several conveniences: it works
out the magnification and true field of view for any telescope-and-eyepiece
pairing, sizes and orients the survey images on the
:ref:`user_guide:object details` screen to match the eyepiece view, and lets
the push-to arrows follow the way your setup moves.

You manage equipment from two places: the :ref:`user_guide:web interface` is
where you add and edit telescopes and eyepieces, and the Equipment screen on the
PiFinder is where you pick which ones are active for tonight's session.

Telescopes and eyepieces
------------------------

A **telescope** records the optical details of one of your instruments: its
make and name, aperture, focal length, central obstruction, and mount type,
along with a few display options covered below. The aperture and focal length
are what let the PiFinder calculate magnification and field of view.
A **telescope** records the optical details of one instrument: make and name,
aperture, focal length, central obstruction, and mount type, plus a few display
options covered below. Aperture and focal length drive the magnification and
field-of-view calculations.

An **eyepiece** records its focal length and apparent field of view (and, if
you know it, the field stop, which gives a more precise field-of-view figure).
You can store as many of each as you like and switch between them as you change
eyepieces through the night.
An **eyepiece** records its focal length and apparent field of view, plus the
field stop if you know it, which gives a more precise field-of-view figure.
Store as many of each as you like and switch between them as the night goes on.

Adding and editing your gear
----------------------------

Telescopes and eyepieces are added through the :ref:`user_guide:web interface`.
Add telescopes and eyepieces through the :ref:`user_guide:web interface`.
Connect to the PiFinder as described there, then open the Equipment page from
the navigation menu. You'll find a list of your telescopes and a list of your
eyepieces, each with buttons to add a new one, edit an existing one, or remove
it.
the navigation menu. You'll find a list of telescopes and a list of eyepieces,
each with buttons to add, edit, or remove an item.

A new PiFinder starts with a generic 200mm Dobsonian and a small set of Plössl
eyepieces so the calculations have something to work with out of the box. Edit
or replace these with your own equipment whenever you're ready.
eyepieces so the calculations work out of the box. Edit or replace these with
your own gear whenever you're ready.

.. note::
The on-device Equipment menu builds its list of telescopes and eyepieces
Expand All @@ -49,68 +45,68 @@ or replace these with your own equipment whenever you're ready.
Choosing your active telescope and eyepiece
-------------------------------------------

The PiFinder uses one **active** telescope and one **active** eyepiece at a
time for its calculations and displays. You can set these from either place:
The PiFinder uses one **active** telescope and one **active** eyepiece at a time
for its calculations and displays. Set these from either place:

* **On the PiFinder**, open the :ref:`user_guide:tools` menu and select
Equipment. The Equipment screen shows your active telescope and eyepiece and,
Equipment. The Equipment screen shows the active telescope and eyepiece and,
when both are set, the resulting magnification and true field of view. Choose
"Telescope..." or "Eyepiece..." to pick from your stored gear.
* **In the web interface**, use the Equipment page to mark a telescope or
eyepiece as active.
eyepiece active.

.. image:: images/equipment/equipment_screen_docs.png

Choosing "Telescope..." or "Eyepiece..." opens a list of your stored gear, with
a check mark next to the active one. Use the **UP/DOWN** arrows to highlight a
different item and **RIGHT** to make it active.
Choosing "Telescope..." or "Eyepiece..." opens a list of your stored gear, a
check mark beside the active one. Use the **UP/DOWN** arrows to highlight an
item and **RIGHT** to make it active.

.. image:: images/equipment/select_telescope_docs.png
:width: 45%
.. image:: images/equipment/select_eyepiece_docs.png
:width: 45%

If nothing is selected, the PiFinder simply skips the magnification and
field-of-view figures and shows the object image in its default orientation.
If nothing is selected, the PiFinder skips the magnification and field-of-view
figures and shows the object image in its default orientation.

Magnification and true field of view
-------------------------------------

Once an active telescope and eyepiece are set, the PiFinder shows two numbers
on the Equipment screen:
With an active telescope and eyepiece set, the PiFinder shows two numbers on the
Equipment screen:

* **Magnification** is the telescope's focal length divided by the eyepiece's
focal length. A 1000mm telescope with a 25mm eyepiece gives 40×.
* **True field of view** (TFOV) is how much sky you actually see through that
combination, in degrees. This is the figure to compare against the push-to
distance: when the object is within half your true field of view of the
centre, it's in the eyepiece.
* **Magnification** is the telescope's focal length divided by the eyepiece's.
A 1000mm telescope with a 25mm eyepiece gives 40×.
* **True field of view** (TFOV) is how much sky you see through that
combination, in degrees. Compare it against the push-to distance: when the
object is within half your true field of view of the centre, it's in the
eyepiece.

The true field of view also sets the starting zoom of the survey image on the
:ref:`user_guide:object details` screen, so the image frames roughly the same
patch of sky your eyepiece shows. You can still zoom in and out from there with
the **+** and **-** keys.
patch of sky your eyepiece shows. Zoom in and out from there with the **+** and
**-** keys.

Both figures also appear on the object image itselfthe field of view in the
top-left corner and the magnification in the top-right — so you always know the
scale of what you're looking at.
Both figures appear on the object image too — field of view in the top-left
corner, magnification in the top-right — so you always know the scale of what
you're looking at.

.. image:: images/equipment/object_image_fov_mag_docs.png

Matching the object image to your eyepiece: flip and flop
---------------------------------------------------------

The survey images on the object details screen are oriented to match the view
through your eyepiece, so you can compare them to what you see directly. Because
different telescopes flip the view in different ways, two per-telescope options
let you correct the orientation:
The survey images on the object details screen are oriented to match your
eyepiece view, so you can compare them directly. Different telescopes flip the
view in different ways, so two per-telescope options let you correct the
orientation:

* **Flip image (upside down)** mirrors the image top to bottom.
* **Flop image (left right)** mirrors the image left to right.

You don't need to reason about your optics to set these. Point at a bright,
recognisable object, compare the object image to your eyepiece view, and toggle
the two options until they match:
You don't need to reason about your optics. Point at a bright, recognisable
object, compare the object image to your eyepiece view, and toggle the two
options until they match:

* If the image is **upside down** compared to the eyepiece, turn on **Flip**.
* If the image is **mirrored** left-to-right, turn on **Flop**.
Expand Down Expand Up @@ -141,7 +137,7 @@ As a starting point for common setups:
A plain Newtonian or Dobsonian needs neither option, which is why both are off
by default. A star diagonal produces a mirror image, so you'll need exactly one
of Flip or Flop; which one depends on how the diagonal sits in the focuser, so
just pick whichever makes the image match.
pick whichever makes the image match.

.. note::
Early PiFinder software shipped the default Dobsonian with Flop turned on by
Expand All @@ -151,9 +147,9 @@ just pick whichever makes the image match.
Reversing the push-to arrows
----------------------------

The same telescope settings include **Reverse Arrow A** and **Reverse Arrow B**.
These flip the direction of the push-to arrows so they point the way your
telescope actually moves. If you find that nudging the scope in the direction an
arrow points sends the target further away instead of closer, turn on the
matching reverse option. The two arrows cover the two directions of movement, so
enable A, B, or both until the arrows guide you the right way.
The same telescope settings include **Reverse Arrow A** and **Reverse Arrow B**,
which flip the push-to arrows so they point the way your telescope actually
moves. If nudging the scope in the direction an arrow points sends the target
further away instead of closer, turn on the matching reverse option. The two
arrows cover the two directions of movement, so enable A, B, or both until the
arrows guide you the right way.
Loading
Loading