Skip to main content

A package for querying orbital and geometric information of spatial objects

Project description

Welcome to the SATQUERY package

PyPI version shields.io PyPI pyversions PyPI status GitHub contributors Maintenance GitHub license Documentation Status Build Status

This package is an archive of scientific routines for querying orbital and geometric information of spatial objects. Currently, operations on objects catalogue query include:

  1. Query of spatial objects on geometric information from DISCOS(Database and Information System Characterising Objects in Space) database;
  2. Query of spatial objects on orbital information from CelesTrak database;
  3. Query of spatial objects on both geometric and orbital information from a combined database;

How to Install

On Linux, macOS and Windows architectures, the binary wheels can be installed using pip by executing one of the following commands:

pip install satcatalogquery
pip install satcatalogquery --upgrade # to upgrade a pre-existing installation

How to use

Targets catalogue query from DISCOS

Query by NORAD_ID, where type of NORAD_ID can be int/str, list of int/str, or a text file named satno.txt in the following format:

# satno
52132
51454
37637
26758
44691
>>> from satcatalogquery import SatCatalog
>>> satcatlog = SatCatalog.discos_query(NORAD_ID=[52132,51454,37637,26758,44691])
>>> # satcatog = SatCatalog.discos_query(NORAD_ID='satno.txt')
>>> satcatlog.df # output pandas dataframe
>>> satcatlog.to_csv() # save dataframe to .csv file

Query by mutiple options at the same time, such as COSPAR_ID, MASS, SHAPE, RCSAvg, etc.

>>> satcatlog = SatCatalog.discos_query(SHAPE=['Box','Pan'],RCSAvg=[0.5,10],DECAYED=False)

Targets catalogue query from CelesTrak

>>> satcatlog = SatCatalog.celestrak_query(MEAN_ALT=[300,2000],ECC=[0.01,0.1],PAYLOAD=False)

Targets catalogue query from combined database

>>> satcatlog = SatCatalog.objects_query(DECAYED=False,RCSAvg=[0.25,10],MEAN_ALT=[250,2000],TLE_STATUS=True,sort='RCSAvg')

Create object SatCatlog from a loacl .csv file

>>> from satcatalogquery import SatCatalog
>>> satcatlog = SatCatalog.from_csv('filename.csv')

Statistics

>>> satcatlog.hist1d('RCSAvg')
>>> satcatlog.hist1d(['StdMag','LAUNCH_DATE'])
>>> satcatlog.hist2d('MEAN_ALT','INCLINATION')
>>> satcatlog.pie('LAUNCH_SITE',cutoff=100)

Download TLE from results of targets catalogue query

>>> tle_path = satcatlog.get_tle()

Download TLE from Norad IDs

>>> from satcatalogquery import download_tle
>>> tle_file = download_tle([52132,51454,37637,26758,44691])
>>> print(tle_file)

Change log

  • 0.2.2 — Apr 24, 2023

    • Change the method .save() to .to_csv()

    • Add methods .discos_query(), .celestrak_query(), .objects_query()to class SatCatalog

    • Change class SatCatlog to SatCatalog

  • 0.2.1 — Jan 4, 2023

    • Add method from_csv and pie to class SatCatlog

    • Add statistics figures to README.md

  • 0.1.1 — Jan 2, 2023

    • The satcatalogquery package was released.

Reference

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

satcatalogquery-0.2.2-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file satcatalogquery-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: satcatalogquery-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.16

File hashes

Hashes for satcatalogquery-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4a78913b7cc435c827c714129011d80f9b96948eebca1a124c7ba04f2c817ccb
MD5 d9ff313e80e9b6d3763cb66ef6f23f0c
BLAKE2b-256 85e32a7be12659b537e187be8a48d1b79fe52b40d8693684807d4cca3d681a04

See more details on using hashes here.

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