Data

Tools

Indexes

Applications

Experiments

Open Source Science

pystortion

https://github.com/spacetelescope/pystortion

Science Score: 28.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: spacetelescope
  • Language: Python
  • Default Branch: master
  • Size: 238 KB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 4
  • Open Issues: 2
  • Releases: 0
Created over 7 years ago · Last pushed almost 5 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

Build Status Documentation Status Coverage Status PyPI version PyPI - License DOI

pystortion

Support for distortion measurements in astronomical imagers.

Functionalities (work in progress)

  • Classes to support fitting of bivariate polynomials of arbitrary degree
  • Helper functions for crossmatching catalogs

Installation

pip install pystortion

Or, clone the repository:
git clone https://github.com/spacetelescope/pystortion
and install pystortion:
cd pystortion
python setup.py install or
pip install .

This package was developed in a python 3.5 environment.

Example usage

For crossmatch, please see tests/test_crossmatch.py

Documentation

pystortion is documented at https://pystortion.readthedocs.io/

Citation

If you find this package useful, please consider citing the Zenodo record using the DOI badge above. Please find additional citation instructions in CITATION.

Contributing

Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. New contributions and contributors are very welcome!
Do you have feedback and feature requests? Is there something missing you would like to see? Please open an issue or send an email to the maintainers. This package follows the Spacetelescope Code of Conduct strives to provide a welcoming community to all of our users and contributors.

The following describes the typical work flow for contributing to the pystortion project (adapted from https://github.com/spacetelescope/jwql): 0. Do not commit any sensitive information (e.g. STScI-internal path structures, machine names, user names, passwords, etc.) to this public repository. Git history cannot be erased. 1. Create a fork off of the spacetelescope pystortion repository on your personal github space. 2. Make a local clone of your fork. 3. Ensure your personal fork is pointing upstream to https://github.com/spacetelescope/pystortion 4. Open an issue on spacetelescope pystortion that describes the need for and nature of the changes you plan to make. This is not necessary for minor changes and fixes. 5. Create a branch on that personal fork. 6. Make your software changes. 7. Push that branch to your personal GitHub repository, i.e. to origin. 8. On the spacetelescope pystortion repository, create a pull request that merges the branch into spacetelescope:master. 9. Assign a reviewer from the team for the pull request. 10. Iterate with the reviewer over any needed changes until the reviewer accepts and merges your branch. 11. Delete your local copy of your branch.

License

This project is Copyright (c) Johannes Sahlmann STScI/AURA and licensed under the terms of the Aura license. This package is based upon the Astropy package template <https://github.com/astropy/package-template>_ which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Owner

  • Name: Space Telescope Science Institute
  • Login: spacetelescope
  • Kind: organization
  • Email: help@stsci.edu
  • Location: Baltimore, MD

STScI is operated by AURA for NASA

Citation (CITATION) 

If you use `pystortion` for work/research presented in a publication (whether
directly, or as a dependency to another package), we recommend and encourage
the following acknowledgment:

  This research made use of pystortion, an open source Python package
  for distortion determination in astronomical imagers (Sahlmann et al, 2019).

where (Sahlmann et al, 2019) is a citation of the Zenodo record:

@software{johannes_sahlmann_2019_3516268,
  author       = {Johannes Sahlmann and
                  P. L. Lim and
                  James Noss},
  title        = {spacetelescope/pystortion: Release for Zenodo},
  month        = oct,
  year         = 2019,
  publisher    = {Zenodo},
  version      = {v0.1.3},
  doi          = {10.5281/zenodo.3516268},
  url          = {https://doi.org/10.5281/zenodo.3516268}
}

We encourage you to also include citations to the papers below in the main text
wherever appropriate.
Recommended BibTeX entries for the paper citations are:

@ARTICLE{JWST-STScI-005492,
	Author = {{Sahlmann}, J.},
	Institution = {STScI},
	Title = {Astrometric accuracy of the JWST calibration field catalog examined with the first Gaia data release},
	Month = {January},
	Number = {{JWST-STScI-005492}},
	Type = {Technical Report},
	Year = {2017},
}

@ARTICLE{Lazorenko:2014aa,
	Author = {{Lazorenko}, P.~F. and {Sahlmann}, J. and {S{\'e}gransan}, D. and {Mart{\'{\i}}n}, E.~L. and {Mayor}, M. and {Queloz}, D. and {Udry}, S.},
	Title = {{Astrometric planet search around southern ultracool dwarfs. II. Astrometric reduction methods and a deep astrometric catalogue}},
	Adsurl = {http://adsabs.harvard.edu/abs/2014A%26A...565A..21L},
	Archiveprefix = {arXiv},
	Arxivurl = {http://arXiv.org/abs/1403.4619},
	Doi = {10.1051/0004-6361/201323271},
	Eid = {A21},
	Eprint = {1403.4619},
	Journal = {\aap},
	Keywords = {astrometry, techniques: high angular resolution, atmospheric effects, parallaxes, brown dwarfs},
	Month = may,
	Pages = {A21},
	Volume = 565,
	Year = 2014,
}

GitHub Events

Total
  • Issues event: 1
Last Year
  • Issues event: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • pllim (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

setup.py pypi
  • astropy *
  • s.strip *