Skip to main content

Python package for working with OIFITS files!

Project description

Name:

python-oifits

Author:

Shreyas Bapat orcid-shreyas

Website:

http://vlbi.software/

Version:
0.1.0

astropy mailing riotchat license docs

Documentation

docs

Complete documentation, including a user guide and an API reference, can be read on the wonderful Read the Docs.

http://oifits.vlbi.software/

Requirements

EinsteinPy requires the following Python packages:

  • NumPy, for basic numerical routines

  • Astropy, for physical units and time handling

oifits is usually tested on Linux on Python 3.6 and 3.7 against latest NumPy.

Installation

The easiest and fastest way to get the package up and running is to install python-oifits using conda:

$ conda install oifits --channel conda-forge

Or for Debian/Ubuntu/Mint users, the package is installable from apt:

$ pip install oifits

And it’s done!

Testing

If installed correctly, the tests can be run using pytest:

$ pytest -vv
============================= test session starts ==============================
platform linux -- Python 3.7.1, pytest-4.3.1, py-1.8.0, pluggy-0.9.0
rootdir: /home/shreyas/Local Forks/python-oifits, inifile: setup.cfg
plugins: remotedata-0.3.1, openfiles-0.3.1, doctestplus-0.3.0, cov-2.5.1, arraydiff-0.3
collected 1 items
[...]
==================== 1 passed, 1 warnings in 28.19 seconds ====================
$

Problems

If the installation fails or you find something that doesn’t work as expected, please open an issue in the issue tracker.

Contributing

oifits is a community project, hence all contributions are more than welcome! For more information, head to CONTRIBUTING.rst.

Developers Documentation can be found here.

Support

mailing

Release announcements and general discussion take place on our mailing list. Feel free to join!

https://groups.io/g/oifits-dev

Please join our [matrix] channel for further queries.

If you still have a doubt, write a mail directly to shreyas@einsteinpy.org.

Citing

If you use oifits on your project, please drop us a line.

You can also use the DOI to cite it in your publications. This is the latest one:

doi

And this is an example citation format:

Shreyas Bapat et al.. (2019). oifits: oifits 0.1.0. Zenodo. 10.5281/zenodo.2582388

What’s the future of the project?

oifits is a part of my Major Technicsl Project. The best way to get an idea of the roadmap is to see the Milestones of the project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oifits-0.1.0.tar.gz (3.0 MB view hashes)

Uploaded Source

Built Distribution

oifits-0.1.0-py3-none-any.whl (17.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page