Commit 996cf425 authored by karpov-sv's avatar karpov-sv
Browse files

Update doc

parent c2852323
......@@ -15,7 +15,7 @@
- ~~pre-processing~~ - should be handled before in an instrument-specific way
- bias/dark subtraction, flatfielding, masking
- object detection and photometry
- SExtractor or SEP for detection, photutils for photometry
- SExtractor or SEP for detection, photutils for photometry
- astrometric calibration
- Astrometry.Net for blind WCS solving
- SCAMP or Astropy-based code for refinement
......@@ -37,14 +37,16 @@
*STDpipe* is available at https://github.com/karpov-sv/stdpipe and is mirrored at https://gitlab.in2p3.fr/icare/stdpipe
You may either install it from GitHub directly as
You may either install it from GitHub directly as
```
python3 -m pip install --user git+https://github.com/karpov-sv/stdpipe
```
or clone the repository and then execute
or better clone the repository and then execute
```
python3 setup.py develop --user
```
to install the package in development (or "editable") mode. This way you may update the repository or apply local patches, and it will immediately be reflected in the installed package.
Apart of Python requirements that will be installed automatically, *STDPipe* also (optionally) makes use of the following external software:
- [SExtractor](https://github.com/astromatic/sextractor)
......@@ -53,6 +55,11 @@ Apart of Python requirements that will be installed automatically, *STDPipe* als
- [HOTPANTS](https://github.com/acbecker/hotpants)
- [Astrometry.Net](https://github.com/dstndstn/astrometry.net)
Most of them may be installed from your package manager. E.g. on Debian or Ubuntu systems it may look like that:
```
sudo apt install sextractor scamp psfex swarp
```
# Usage
There is no documentation for *STDPipe* yet, but you may check the examples inside [notebooks/](notebooks/) folder, especially the [tutorial](notebooks/stdpipe_tutorial.ipynb) that demonstrates basic steps of a typical image processing.
The [documentation for *STDPipe*](https://stdpipe.readthedocs.io/) is now being actively written. In the meantime you may check the examples inside [notebooks/](notebooks/) folder, especially the [tutorial](notebooks/stdpipe_tutorial.ipynb) that demonstrates basic steps of a typical image processing.
......@@ -176,7 +176,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# html_static_path = ["_static"]
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
......@@ -337,3 +337,4 @@ apidoc_output_dir = 'api'
apidoc_excluded_paths = ['tests']
apidoc_separate_modules = True
apidoc_toc_file = None
apidoc_module_first = True
"""
STDPipe - Simple Transient Detection Pipeline.
*STDPipe* is a set of Python routines for astrometry, photometry and transient
detection related tasks, intended for quick and easy implementation of custom
pipelines, as well as for interactive data analysis.
"""
"""
Module containing higher-level pipeline building blocks, wrapping together lower-level
functionality of STDPipe modules.
"""
from __future__ import absolute_import, division, print_function, unicode_literals
import os
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment