Cloud Optimized Fits
cloud-fits provides the means to index large FITS files and have them served over HTTP(s) for efficient access. A
scientist or team can index the FITS file-directory, then upload the file-directory to A Static Cloud Provider. Static
Cloud Providers are Amazon WebServices, Google Cloud, Digital Ocean Spaces, or Microsoft Blob Storage. The FITS Cloud
Index can than be checked into a Github Repository, shared, or uploaded to a Static Cloud Provider
cloud-fits returns Astropy Datatypes as much as possible
Lets index a FITS files and extract Metadata from it
Accessing Data
Registry of Open Data on AWS provides a bucket called stpubdata. It contains data uploaded from the Transiting
Exoplanet Survey Satellite. The type of data files we'll be working with in this tutorial are
about 44GB. It'll cost about $1.05 to download and index one of these 352 files from the Registry. To save time and
money, we'll only download one and index it
Prerequisite
Before we can download data off the Registry. Setup an AWS account and configure your credentials file. Then install
aws-cli
- https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/
- https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html
- https://pypi.org/project/awscli/
Tutorial
Lets create our environment and download one data-file from the Registry
$ mkdir -p /tmp/tess-data
$ cd /tmp/tess-data
$ aws s3 cp s3://stpubdata/tess/public/mast/ . --recursive --exclude "*" --include "tess-s0022-4-4-cube.fits" --request-payer
With our data downloaded, its time to create a bucket that'll hold our FITS Cloud Index. In some cases, we might not
have write access to the data we're indexing. In this case, we want to generate the index from a public data-set. Then
well store the index in a Static Cloud Provider of our choosing. cloud-fits can then provide a Pythonic API
augmenting this abstraction
Lets create a bucket on AWS S3 and upload the index there
$ AWS_DEFAULT_REGION=us-east-1 aws s3api create-bucket --bucket tess-fits-cloud-index
$ pip install cloud-fits -U
$ cloud-fits-index --index-bucket-name tess-fits-cloud-index --fits-files-directory /tmp/tess-data/ --data-bucket-path s3://stpubdata/tess/public/mast
The arguments --index-bucket-name and --fits-file-directory are intended to be straight forward with the naming.
--data-bucket-path is used to arugment the file-structure difference between --fits-file-directory and --data-bucket-path.
For example, the data-cubes are located in tess/public/mast, but this data isn't captured in --fits-file-directory. So,
--data-bucket-path was introduced to augment the paths used to download sections of the file
Okay, great. We have everything we need. Now lets do some science. Start python and enter the following,
from cloud_fits.bucket_operations import download_index
from cloud_fits.datatypes import FitsCloudIndex
from pprint import pprint
BUCKET_NAME: str = 'tess-fits-cloud-index'
index: FitsCloudIndex = download_index(BUCKET_NAME)
bintable_index = index.headers[2]
print(bintable_index[0, 10])
Feature Map
- Amazon Web Services S3
- Pythonic API Refinement ( Planned Update )
- Remote Indexing for all Static Cloud Providers ( Planned Support )
- Digital Ocean Spaces ( Planned Support )
- Google Object Storage ( Planned Support )
- Microsoft Azure ( Planned Support )
Development and Deployment
Building Docs Locally
build.sh has a script that'll generate docs locally into /tmp/docs. The static HTML files can then be served from
that directory using these commands
$ bash build.sh docs
$ cd /tmp/docs
$ python3 -m http.server
PYPI Automation
build.sh has a script that'll generate the python wheel, sdist, and associated files. Then it'll upload it to
PYPI or PYPI-Test according to how you invoke the build.sh file
$ bash build.sh publish-test
Metadata
Release files for cloud-fits 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cloud-fits-0.1.1.tar.gz | 19.4 kB | Without provenance | Details for cloud-fits-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cloud_fits-0.1.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for cloud_fits-0.1.1-py2.py3-none-any.whl |
Total release size: 36.7 kB
Release files / cloud-fits-0.1.1.tar.gz
| Download URL | cloud-fits-0.1.1.tar.gz |
|---|---|
| Size | 19.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
07ffb6bc65c9c55e14e0b070fcd496853e3d050d095fe0dfe14182475c35e19e
|
|
BLAKE2b-256 checksum How to use checksums |
efb815e629a212f6b8012810af2318b48105088e450abadb86e9f92f26ff5211
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9
|
Release files / cloud_fits-0.1.1-py2.py3-none-any.whl
| Download URL | cloud_fits-0.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 17.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f982012bf363c293543905c509e7dda94f594847a38aa01145c25f9f19996129
|
|
BLAKE2b-256 checksum How to use checksums |
0f2331c12c7a5d7ac9802406bf626ca0d7782222ac0f83f9786ba87ceecb6586
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9
|
Security for cloud-fits 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.