dfitspy

dfitspy: a dfits|fitsort implementation in python - Published in JOSS (2019)

https://github.com/Romain-Thomas-Shef/dfitspy

Science Score: 36.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

FITS file header search and display

Basic Info
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 0
  • Open Issues: 8
  • Releases: 6
Created almost 8 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

What is dfitspy?

The full documentation can be found here.

The FITS (Flexible Image Transport System) is one of the most used format in astronomy [https://fits.gsfc.nasa.gov/fits_documentation.html]. It is used to store a lot of different types of data such as 1D or 2D spectra, 3D data cubes. The FITS files are built with two components. The data themselves are stored as tables and contains any types of data. Then a header is built containing set of keywords-value pairs aiming at describing the data themselves.

The present python module, dfitspy, is a small project that migrates the main dfits and fitsort capabilities to python [https://www.eso.org/sci/software/eclipse/eug/eug/node8.html]. It is a metadata searcher/displayer for FITS files. As dfits and fitsort, dfitspy is able to display in the terminal the result of a metadata search and is able to grep certain values of keywords inside large samples of files. Therefore it can be used directly with the command line interface. Nevertheless, dfitspy can be, and it is its strength, imported as a python module the user can use these functionnalities inside another python code or the python interpretor.

What is not dfitspy?

dfitspy does not read data inside fits file. Other libraries are doing this very efficiently and dfitspy is not made for that (see fitsio and astropy). It works only on the header and allows you to search/display the fits files header. It is also made to find common values in large amount of fits files in a very fast way.

Installation?

The last dfitspy version is v19.3.3 and is available in the pypi test repository. To install it::

 pip install dfitspy --user

Using this command will allow you not to have to install any other package. Pip will install what is missing for you.


Contribute! dfitspy is not perfect! It has been primarily developed for my private research and I decided to release in the spirit of making the research process as transparent as possible and in the hope it can be used by other people. If you have any comment or anything you would like to be added to dfitspy, or, even better, if you want to modify you can either do it yourself or please feel free to contact me! ---> *romain.thomas@sheffield.ac.uk


Copyright

dfitspy is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.

dfitspy is distributed without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program. If not, see http://www.gnu.org/licenses/ .


Disclaimer

dfitspy is not supported nor endorsed by the European Southern Observatory [ESO].

Acknowledgments

The python wrapper of the CFITSIO library have been made for the fitsio python library (https://github.com/esheldon/fitsio) and is used in dfitspy.

Owner

  • Name: Romain Thomas
  • Login: Romain-Thomas-Shef
  • Kind: user

Head of Research Software Engineering @ University of Sheffield

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 7
  • Pull request event: 1
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 7
  • Pull request event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 98
  • Total Committers: 3
  • Avg Commits per committer: 32.667
  • Development Distribution Score (DDS): 0.102
Past Year
  • Commits: 9
  • Committers: 1
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
romain t****j@g****m 88
Romain-Thomas-Shef r****s@s****k 9
Arfon Smith a****n 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 16
  • Total pull requests: 5
  • Average time to close issues: 2 days
  • Average time to close pull requests: 1 minute
  • Total issue authors: 7
  • Total pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.2
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: 10 minutes
  • Average time to close pull requests: less than a minute
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 2.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • taldcroft (8)
  • Knusper (3)
  • jlillo (1)
  • vertighel (1)
  • fpavogt (1)
  • mgalloy (1)
  • EdwinB12 (1)
Pull Request Authors
  • Romain-Thomas-Shef (2)
  • danielskatz (2)
  • arfon (1)
Top Labels
Issue Labels
enhancement (1) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 52 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 10
  • Total maintainers: 1
pypi.org: dfitspy
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 52 Last month
Rankings
Dependent packages count: 9.8%
Dependent repos count: 21.8%
Average: 22.1%
Downloads: 23.8%
Stargazers count: 25.1%
Forks count: 29.9%
Maintainers (1)
Last synced: 10 months ago

Dependencies

dfitspy.egg-info/requires.txt pypi
  • astropy >=4.0
  • numpy >=1.14.3
  • python-magic >=0.4.15
.github/workflows/JOSS_paper.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • openjournals/openjournals-draft-action master composite
pyproject.toml pypi
  • astropy >= 7.0
  • numpy >= 2.2.1
  • python-magic >= 0.4.27