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

Updated readme #204

Closed
wants to merge 17 commits into from
Closed
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
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
python-version: '3.10'
toxenv: py310

- name: Python 3.11
- name: Python 3.9
runs-on: ubuntu-latest
python-version: 3.11
toxenv: py311
python-version: 3.9
toxenv: py39

- name: Python 3.12
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/weekly_cron.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI
name: Weekly cron

on:
schedule:
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
STWCS
-----

.. image:: https://github.com/spacetelescope/stwcs/workflows/CI/badge.svg
.. image:: https://github.com/spacetelescope/stwcs/actions/workflows/weekly_cron.yml/badge.svg
:target: https://github.com/spacetelescope/stwcs/actions
:alt: CI Status

Expand All @@ -25,4 +25,4 @@ To clone the project from github::

To install::

python setup.py install
pip install .
2 changes: 1 addition & 1 deletion doc/source/fits_convention_tsr/source/sip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ due to velocity aberration observed due to the motion of HST in orbit. The typi
for HST cameras results in a measurable velocity aberration with variations from the center of
the field of view to the edge on the order of 0.1 pixels. More details about this correction can
be found in `Appendix A.3 of the DrizzlePac Handbook
<http://documents.stsci.edu/hst/HST_overview/documents/DrizzlePac/DrizzlePac.cover.html>`_.
<https://hst-docs.stsci.edu/drizzpac>`_.

This scale factor gets computed by
the HST ground systems for start of each exposure and recorded as the VAFACTOR keyword in each
Expand Down
18 changes: 9 additions & 9 deletions doc/source/hstwcs_ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,13 @@ Create an HSTWCS Object
--------------------------
- Create an HSTWCS object using a pyfits HDUList and an extension number

``fobj = pyfits.open('some_file.fits')``
``from astropy.io import fits``

``w = wcsutil.HSTWCS(fobj, 3)``
``from stwcs import wcsutil``

``hdu = fits.open('some_file.fits')``

``w = wcsutil.HSTWCS(hdu, 3)``

- Create an HSTWCS object using a qualified file name.

Expand All @@ -24,10 +28,6 @@ Create an HSTWCS Object
- Create an HSTWCS object from WCS with key 'O'.

``w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2, wcskey='O')``

- Create a template HSTWCS object for a DEFAULT object.

``w = wcsutil.HSTWCS(instrument='DEFAULT')``

----------------------------------
Coordinate Transformation Examples
Expand All @@ -50,9 +50,9 @@ of the first image pixel is (0,0).

- Apply the entire detector to sky transformation at once:

``outpix = w1.all_pix2world(inpix, 1)``
``outpix = w.all_pix2world(inpix, 1)``

``outpix = w1.all_pix2world(X, Y, 1)``
``outpix = w.all_pix2world(X, Y, 1)``

- The same transformation can be done in separate steps:

Expand All @@ -76,6 +76,6 @@ of the first image pixel is (0,0).
5. Finally the transformation from undistorted to world coordinates is done
by applying the linear WCS.

``wpix = w.wcs_pix2sky(fpix, 1)``
``wpix = w.wcs_pix2world(fpix, 1)``


1 change: 0 additions & 1 deletion stwcs/updatewcs/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import os
import string
from stsci.tools import fileutil

import logging
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist= py310, py311, py312, style, dev
envlist= py311, py312, py310, style, dev

[testenv]

Expand Down
Loading