<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Executable Scripts — Astropy v0.2.4</title>
<link rel="stylesheet" href="../../../_static/bootstrap-astropy.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../../../_static/astropy_logo.ico"/>
<link rel="top" title="Astropy v0.2.4" href="../../../index.html" />
<link rel="up" title="FITS File handling (astropy.io.fits)" href="../index.html" />
<link rel="next" title="Miscellaneous Features" href="misc.html" />
<link rel="prev" title="Less Familiar Objects" href="unfamiliar.html" />
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../../../index.html"></a>
<ul>
<li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../../../genindex.html">Index</a></li>
<li><a title="Python Module Index" href="../../../py-modindex.html">Modules</a></li>
<li>
<form action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<a href="misc.html" title="Miscellaneous Features">
next »
</a>
</li>
<li class="right">
<a href="unfamiliar.html" title="Less Familiar Objects">
« previous
</a>
|
</li>
<li>
<a href="../../../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../index.html" accesskey="U">FITS File handling (<tt class="docutils literal"><span class="pre">astropy.io.fits</span></tt>)</a> »</li>
<li>Executable Scripts</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="executable-scripts">
<h1>Executable Scripts<a class="headerlink" href="#executable-scripts" title="Permalink to this headline">¶</a></h1>
<p>Astropy installs a couple of useful utility programs on your system that are
built with Astropy.</p>
<div class="section" id="module-astropy.io.fits.scripts.fitscheck">
<span id="fitscheck"></span><h2>fitscheck<a class="headerlink" href="#module-astropy.io.fits.scripts.fitscheck" title="Permalink to this headline">¶</a></h2>
<p>fitscheck is a command line script based on astropy.io.fits for verifying and
updating the CHECKSUM and DATASUM keywords of .fits files. Fitscheck can also
detect and often fix other FITS standards violations. fitscheck facilitates
re-writing the non-standard checksums originally generated by astropy.io.fits
with standard checksums which will interoperate with CFITSIO.</p>
<p>fitscheck will refuse to write new checksums if the checksum keywords
are missing or their values are bad. Use –force to write new
checksums regardless of whether or not they currently exist or pass.
Use –ignore-missing to tolerate missing checksum keywords without
comment.</p>
<p>Example uses of fitscheck:</p>
<ol class="arabic">
<li><p class="first">Verify and update checksums, tolerating non-standard checksums, updating to
standard checksum:</p>
<div class="highlight-python"><pre>$ fitscheck --checksum either --write *.fits</pre>
</div>
</li>
<li><p class="first">Write new checksums, even if existing checksums are bad or missing:</p>
<div class="highlight-python"><pre>$ fitscheck --write --force *.fits</pre>
</div>
</li>
<li><p class="first">Verify standard checksums and FITS compliance without changing the files:</p>
<div class="highlight-python"><pre>$ fitscheck --compliance *.fits</pre>
</div>
</li>
<li><p class="first">Verify original nonstandard checksums only:</p>
<div class="highlight-python"><pre>$ fitscheck --checksum nonstandard *.fits</pre>
</div>
</li>
<li><p class="first">Only check and fix compliance problems, ignoring checksums:</p>
<div class="highlight-python"><pre>$ fitscheck --checksum none --compliance --write *.fits</pre>
</div>
</li>
<li><p class="first">Verify standard interoperable checksums:</p>
<div class="highlight-python"><pre>$ fitscheck *.fits</pre>
</div>
</li>
<li><p class="first">Delete checksum keywords:</p>
<div class="highlight-python"><pre>$ fitscheck --checksum none --write *.fits</pre>
</div>
</li>
</ol>
<p>With Astropy installed, please run <tt class="docutils literal"><span class="pre">fitscheck</span> <span class="pre">--help</span></tt> to see the full program
usage documentation.</p>
</div>
<div class="section" id="fitsdiff">
<h2>fitsdiff<a class="headerlink" href="#fitsdiff" title="Permalink to this headline">¶</a></h2>
<p>fitsdiff provides a thin command-line wrapper around the <a class="reference internal" href="../api/diff.html#astropy.io.fits.FITSDiff" title="astropy.io.fits.FITSDiff"><tt class="xref py py-class docutils literal"><span class="pre">FITSDiff</span></tt></a>
interface–it outputs the report from a <a class="reference internal" href="../api/diff.html#astropy.io.fits.FITSDiff" title="astropy.io.fits.FITSDiff"><tt class="xref py py-class docutils literal"><span class="pre">FITSDiff</span></tt></a> of two FITS files,
and like common diff-like commands returns a 0 status code if no differences
were found, and 1 if differences were found:</p>
<p>With Astropy installed, please run <tt class="docutils literal"><span class="pre">fitscheck</span> <span class="pre">--help</span></tt> to see the full program
usage documentation.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">Executable Scripts</a><ul>
<li><a class="reference internal" href="#module-astropy.io.fits.scripts.fitscheck">fitscheck</a></li>
<li><a class="reference internal" href="#fitsdiff">fitsdiff</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="http://github.com/astropy/astropy/tree/v0.2.4/docs/io/fits/usage/scripts.rst">Edit This Page on Github</a>
<a href="../../../_sources/io/fits/usage/scripts.txt"
rel="nofollow">Page Source</a>
<a href="#">Back to Top</a></p>
<p>
© Copyright 2011-2013, The Astropy Developers.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last built 22 Oct 2013. <br/>
</p>
</footer>
</body>
</html>
