Skip to content

Commit

Permalink
Merge pull request #122 from masterhit/patch-1
Browse files Browse the repository at this point in the history
minor spelling and grammar fixes - diy_reduction_script.ipynb
  • Loading branch information
juliotux authored Oct 13, 2023
2 parents 4e0ea93 + 3af27de commit 18a89b7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/ipynb/diy_reduction_script.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
"\n",
"ASTROPOP is not a reduction script by itself, but a library containing (almost) everything you need to create your reduction script by yourself.\n",
"\n",
"In this guide we will follow a standard reduction procedure using the ASTROPOP modules and you can follow it to perform your own reduction.\n",
"In this guide, we will follow a standard reduction procedure using the ASTROPOP modules and you can follow it to perform your own reduction.\n",
"\n",
"If you want to use this notebook directly in your Jupyter, you can download it in [this link](https://raw.githubusercontent.com/sparc4-dev/astropop/main/docs/ipynb/diy_reduction_script.ipynb)."
"If you want to use this notebook directly in your Jupyter, you can download it at [this link](https://raw.githubusercontent.com/sparc4-dev/astropop/main/docs/ipynb/diy_reduction_script.ipynb)."
]
},
{
Expand All @@ -21,13 +21,13 @@
"source": [
"## Organize Your Data\n",
"\n",
"The first step is to organize your data. *Do not forget to backup all the raw data before start your reduction!*\n",
"The first step is to organize your data. *Do not forget to backup all the raw data before starting your reduction!*\n",
"\n",
"Here we will perform a reduction using just bias and flatfield corrections, in a single band. No dark frame subtraction will be used, so we do not have to set it.\n",
"\n",
"First, we will have to create the lists containing the image names we need. You can do it manually, using [glob](https://docs.python.org/3/library/glob.html) package, or the built-in file organizer of ASTROPOP. This last option allow filtering using header keys, but may be slow and memory consuming for very large sets (with thousands of images). For didatic reasons, we will to it with ASTROPOP file organizer.\n",
"\n",
"Is convenient to set now some directory names for raw, reduced and temporary files, as in the code bellow."
"It is convenient to set now some directory names for raw, reduced and temporary files, as in the code below."
]
},
{
Expand Down Expand Up @@ -68,7 +68,7 @@
"source": [
"In this tutorial, we will a set of images of HD5980 star taken in Observatório do Pico dos Dias (OPD/LNA) and available in [github/sparc4-dev/astropop-data](https://github.com/sparc4-dev/astropop-data) repository.\n",
"\n",
"To download these data in the raw folder, follow the script bellow."
"To download these data in the raw folder, follow the script below."
]
},
{
Expand All @@ -77,7 +77,7 @@
"metadata": {},
"outputs": [],
"source": [
"# Downloading the data. If you alrady downloaded it, you can skip this cell\n",
"# Downloading the data. If you already downloaded it, you can skip this cell\n",
"import urllib.request\n",
"import os\n",
"\n",
Expand All @@ -92,9 +92,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"With `astropop.file_collection.FitsFileGroup` we will create a dynamic library of fits files. This library allow iterate over its files, filter by header keywords, access file names or direct access a given index. In this case, we will access only the file names via `FitsFileGroup.files` property.\n",
"With `astropop.file_collection.FitsFileGroup` we will create a dynamic library of fits files. This library allows iterating over its files, filtering by header keywords, accessing file names or direct access to a given index. In this case, we will access only the file names via `FitsFileGroup.files` property.\n",
"\n",
"For the `filtered` method, the arguments is a dictionary containing all keywords you want to filter in the header. Only equality is allowed. In this example, we will filter our files by the `obstype` key, that can have values `BIAS`, `FLAT` and `SCIENCE`. For science, if you have multiple stars, you can use a second key, `object`, to filter the desired images. This is the standard of our observations, but your observatory may contian a different standard."
"For the `filtered` method, the arguments is a dictionary containing all keywords you want to filter in the header. Only equality is allowed. In this example, we will filter our files by the `obstype` key, which can have values `BIAS`, `FLAT` and `SCIENCE`. For science, if you have multiple stars, you can use a second key, `object`, to filter the desired images. This is the standard of our observations, but your observatory may contian a different standard."
]
},
{
Expand Down

0 comments on commit 18a89b7

Please sign in to comment.