Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs a bit #445

Merged
merged 2 commits into from
Sep 13, 2024
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
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ You will go through this process to do photometry.
#. Once those settings have been done, you can perform photometry on your images.


Graphical interface for making settings
---------------------------------------
Graphical interface for making settings and doing photometry
------------------------------------------------------------

A graphical interface is provided via JupyterLab to make settings. To start JupyterLab, run the following command
in a terminal::
Expand Down
36 changes: 5 additions & 31 deletions stellarphot/notebooks/01-initial-settings.ipynb
Original file line number Diff line number Diff line change
@@ -1,51 +1,25 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"id": "3a7f0b18-4509-474e-b42e-a69edd22913b",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.settings import Camera, Observatory, PassbandMap\n",
"from stellarphot.settings.custom_widgets import ReviewSettings"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "37494092-bd26-4dcb-a7d9-d587fd79ca45",
"metadata": {},
"outputs": [],
"source": [
"review = ReviewSettings([Camera, Observatory, PassbandMap])"
]
},
{
"cell_type": "markdown",
"id": "f25dc64e-e0b9-4673-b806-ef0e1f53f84c",
"metadata": {},
"source": [
"# Review or make key settings in the widget below "
"# Run the cell below and enter information about your camera and observatory"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "fe341afc-4171-4094-8165-82faa26706b3",
"id": "3a7f0b18-4509-474e-b42e-a69edd22913b",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.settings import Camera, Observatory, PassbandMap\n",
"from stellarphot.settings.custom_widgets import ReviewSettings\n",
"review = ReviewSettings([Camera, Observatory, PassbandMap])\n",
"review"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "7c58cd05-afff-4273-8607-69a0e93f4fa4",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down
22 changes: 6 additions & 16 deletions stellarphot/notebooks/02-seeing-and-comparison.ipynb
Original file line number Diff line number Diff line change
@@ -1,32 +1,22 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"id": "713e8c74-240c-453a-a35b-3011f8869435",
"cell_type": "markdown",
"id": "d3515987",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.gui_tools.profile_and_comps import ComparisonAndSeeing"
"# Run the cell below to choose an aperture radius and comparison stars"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "8dd2508a-3488-4a19-93ba-40ac87475a28",
"metadata": {},
"outputs": [],
"source": [
"cs = ComparisonAndSeeing()"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "68074870-16a6-4509-bee0-16e9d214f634",
"id": "713e8c74-240c-453a-a35b-3011f8869435",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.gui_tools.profile_and_comps import ComparisonAndSeeing\n",
"cs = ComparisonAndSeeing()\n",
"cs"
]
}
Expand Down
36 changes: 5 additions & 31 deletions stellarphot/notebooks/03-final-review-of-settings.ipynb
Original file line number Diff line number Diff line change
@@ -1,51 +1,25 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"id": "3b91d12e-97ae-4d6d-970d-562b6bbfd683",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.settings import Camera, LoggingSettings, Observatory, PassbandMap, PhotometryApertures, PhotometryOptionalSettings, SourceLocationSettings\n",
"from stellarphot.settings.custom_widgets import ReviewSettings"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "d57c16cc-c243-47f3-9747-94d6c6898621",
"metadata": {},
"outputs": [],
"source": [
"review = ReviewSettings([Camera, Observatory, PassbandMap, PhotometryApertures, SourceLocationSettings, PhotometryOptionalSettings, LoggingSettings])"
]
},
{
"cell_type": "markdown",
"id": "36db3d1f-d0d7-413e-ab77-766c6e3d02a1",
"metadata": {},
"source": [
"# Review or make key settings in the widget below "
"# Review settings in the widget below before beginning photometry"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "39491574-cc9f-4d2b-963f-1b175336a16d",
"id": "3b91d12e-97ae-4d6d-970d-562b6bbfd683",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.settings import Camera, LoggingSettings, Observatory, PassbandMap, PhotometryApertures, PhotometryOptionalSettings, SourceLocationSettings\n",
"from stellarphot.settings.custom_widgets import ReviewSettings\n",
"review = ReviewSettings([Camera, Observatory, PassbandMap, PhotometryApertures, SourceLocationSettings, PhotometryOptionalSettings, LoggingSettings])\n",
"review"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "629f505c-6fab-4bf9-a30a-130bf668d8ac",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down
19 changes: 1 addition & 18 deletions stellarphot/notebooks/04-launch-photometry.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,10 @@
"source": [
"import ipywidgets as ipw\n",
"\n",
"from stellarphot.settings.custom_widgets import PhotometryRunner"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "c5eed8a2-7533-4411-8f6e-303b854f4e3e",
"metadata": {},
"outputs": [],
"source": [
"from stellarphot.settings.custom_widgets import PhotometryRunner\n",
"runner = PhotometryRunner()\n",
"runner"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "efcc3d42-3a2f-46b2-9f13-4a23c0790dc2",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down