https://github.com/greenbankobservatory/diffdirs

Tool to diff two directories containing FITS files
https://github.com/greenbankobservatory/diffdirs

diff fits

Last synced: about 15 hours ago
JSON representation

Tool to diff two directories containing FITS files

• Host: GitHub
• URL: https://github.com/greenbankobservatory/diffdirs
• Owner: GreenBankObservatory
• License: mit
• Created: 2018-08-22T18:05:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-22T18:58:53.000Z (about 6 years ago)
• Last Synced: 2024-11-05T19:09:24.056Z (15 days ago)
• Topics: diff, fits
• Language: Python
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: ChangeLog
  • License: LICENSE

Awesome Lists containing this project

README

        
`diffdirs`: FITS regression testing made easy

=============================================

`diffdirs` is a simple tool to diff two directories containing FITS files. The most obvious use case here is for regression testing of software that produces FITS files. You want to ensure that:

1. The directory structure is identical, except for log files, etc. This includes:

     a) Files in "new" directories that are not in the "original" (i.e. missing files)

     b) Files in the "old" directory that are not in one or more "new" directories (i.e. extra files)

2. The contents of all FITS files are identical, except for certain types of metadata

Installation

------------

Install from pip (recommended):

::

    $ pip install diffdirs

Or, install straight from the repo:

::

    $ git clone https://github.com/GreenBankObservatory/diffdirs

    $ pip install diffdirs

Usage

-----

Use the wrapper script (recommended):

::

    $ diffdirs -h

Call the module:

::

    $ python -m diffdirs -h

Import as library:

::

    $ python

    >>> from diffdirs.diffdirs import diff_dirs

    >>> help(diff_dirs)

Build

-----

To build bundles for publication:

::

    $ rm -rf dist/* && python setup.py sdist && python setup.py bdist_wheel

Publish

-------

::

    $ twine upload dist/*