Data

Tools

Indexes

Applications

Experiments

Open Source Science

cavsiopy

Calculation and Visualization of Spacecraft Instrument Orientation

https://github.com/icebearcanada/cavsiopy

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 7 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.3%) to scientific vocabulary

Keywords

cassiope hf ionosphere rri spacecraft spacecraft-attitude swarm-e
Last synced: 6 months ago · JSON representation ·

Repository

Calculation and Visualization of Spacecraft Instrument Orientation

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 4
Topics
cassiope hf ionosphere rri spacecraft spacecraft-attitude swarm-e
Created almost 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

cavsiopy: Calculation and Visualization of Spacecraft Instrument Orientation

DOI

cavsiopy

Welcome to cavsiopy!

'cavsiopy' is an open source Python package, which was specifically developed to determine the look direction of the Radio Receiver Instrument (RRI) on the e-POP/ CASSIOPE/ Swarm-E for HF radio wave propagation studies, but can be applied to any satellite mission requiring accurate pointing information. Given the spacecraft position, the roll, yaw, and pitch angles, the body vector of the instrument, and a target location, the pointing direction and orientation of the instrument onboard the spacecraft with respect to the target can be determined in various reference frames. 'cavsiopy' supports the reference frames: Geocentric Equatorial Inertial J2000 (GEI J2K), Earth Centered Earth Fixed (ECEF), International Terrestrial Reference Frame (ITRF), geodetic North-East-Down, and geocentric North-East-Center.

cavsiopy contains routines for

  1. Rotating the look direction of an instrument on-board the spacecraft in orbital frame

  2. Calculation of the look angles of the spacecraft (elevation and azimuth)

  3. Calculation of the look angles of the instrument (elevation and azimuth)

  4. Calculation of the distance between the spacecraft and a designated point on the ground

  5. Calculation of the line-of-sight direction vector from the target to the spacecraft location

  6. Transformations between GEI J2K, ECEF, NED, NEC, ICRF, ITRF reference frames

  7. Visualization of spacecraft and instrument direction in 2D and 3D (simple or overlaid on geographical regions of the Earth below the satellite trajectory)

  8. Rotation matrices for rotations by x, y, z axes

Instrument pointing direction vectors can be obtained in GEI J2K, ECEF, NED, NEC, ICRF, ITRF.

Citation

If you use any of the cavsiopy functions/modules/plots please cite the software using DOI: https://doi.org/10.5281/zenodo.8361256 as in:

Kalafatoglu Eyiguler, E. C., Holley, W., Howarth, A. D., Danskin, D. W., Pandey, K., Martin, C. J., et al. (2023b). icebearcanada/cavsiopy: v1.1.1. doi:10.5281/zenodo.8361256

cavsiopy in-action:

  1. Kalafatoglu Eyiguler, E. C., Holley, W., Howarth, A. D., Danskin, D. W., Pandey, K., Martin, C. J., Gillies, R. G., and Yau, A. W. & Hussey, G. C. (2023). c avsiopy: a Python package to calculate and visualize spacecraft instrument orientation. Frontiers in Astronomy and Space Sciences, 10, 1278794.

  2. Kalafatoglu Eyiguler, E. C., Danskin, D., Hussey, G., Pandey, K., Gillies, R., and Yau, A. (2022). Satellite attitude effects on the reception of transionospheric hf signals: Examples from the radio receiver instrument onboard e-pop/swarm-e. In 2022 3rd URSI Atlantic and Asia Pacific Radio Science Meeting(AT-AP-RASC) (IEEE), 1–4

  3. Kalafatoglu Eyiguler, E. C., Danskin, D. W., Howarth, A. D., Holley, W., Pandey, K., Gillies, R. G., et al. (2023). Attitude effects on the observed orientation angle of hf waves from the radio receiver instrument on e-pop/swarm-e. In Ionospheric Effects Symposium 2023 (IES2023), ed. K. Groves (Alexandria, VA, USA: IES 2023), 1–6

  4. Pandey, K., Eyiguler, E. K., Gillies, R. G., Hussey, G. C., Danskin, D. W., and Yau, A. W. (2022). Polarization characteristics of a single mode radio wave traversing through the ionosphere: A unique observation from the rri on epop/swarm-e. Journal of Geophysical Research: Space Physics 127. doi:10.1029/2022JA030684

Documentation

Detailed documentation on readthedocs.org

Dependencies

numpy, matplotlib, astropy, cartopy, geopy, h5py, pysofa2

Installation using pip:

Before installing cavsiopy some of the dependencies may need special installation instructions:

cartopy

  • If you are installing cartopy via pip (on Ubuntu/Debian) first libgeos-dev has to be on your system:

$ sudo apt -y install libgeos-dev

  • Please follow the installation guide of cartopy for other systems from here: https://scitools.org.uk/cartopy/docs/latest/installing.html

  • installation of cartopy using conda:

$ conda install -c conda-forge cartopy

Other packages and requirements

Download the requirements.txt from our GitHub repository

$ pip install -r requirements.txt ** Now, we are good to go! **

$ pip install cavsiopy

Releases

Current release: v1.2.2

Version 1.2.2

Patch release:

  1. slew_example.py: added to examples

  2. in attitude_analysis.py: functions in utils.py and complement_missing_sofa.py are now embedded in attitude_analysis.py

  3. use_rotation_matrices.py: utils.py and missing_complement_sofa.py imports removed

  4. attitude_analysis.spacecraft_distance_from_a_point: fixed a minor bug, which caused the distance array to return empty.

  5. requirements.txt: version numbers were added for dependencies.

  6. .readthedocs.yaml: version number and installation instructions corrected.

The structural changes in items 2 and 3 do not affect any end-user experience / call to functions etc.

Version 1.2.1

Minor release: change in the return parameters of find_attitude and cas_ephemeris.

  1. attitude_analysis.find_attitude: East-North-Up: enu and Easth-North-Center(up): enc_u have been added to the returns.

  2. utils.py: added to find the location of coefficient files for pysofa, and removed the declaration of coefficient files for pysofa for the find_attitude function.

  3. ephemeris_importer.cas_ephemeris: Eclipse parameter can now be imported using ephemeris_importer.cas_ephemeris function from the CAS_ephemeris data files.

  4. __init__.py: Citation information has been added.

  5. requirements.txt: file has been updated.

Version 1.1.1

patch release:

  1. 'attitude_plotter.attitude_3d_ground_quiver': has been enhanced to display a line connecting the subsatellite point with the ground target on the ground map.

  2. rri_example.py: rotate_rri is renamed as 'rotate_inst.'

  3. auxiliary\preliminary_data_analysis.py: name changes for plot_data_validity, import_quaternions.

Version 1.1.0

'pysofa2' integration.

In previous versions, cavsiopy used the 'pysofa' package developed by Frederic Grollier from 2010.

Starting from version 1.1.0, we have transitioned to using 'pysofa2.'

To address missing functions in 'pysofa2,' we introduced 'complement_missing_sofa.py,' which utilizes the SOFA C Library compiled by 'pysofa2.'

Version 1.0.0

Initial major release: Uses pysofa (https://pypi.org/project/pysofa/) to compute the ICRF to ITRF rotation matrix

Before v1.0.0

Test releases

Credits: E. Ceren Kalafatoglu Eyiguler, Warren Holley, Andrew D. Howarth, Donald W. Danskin, Kuldeep Pandey, Carley J. Martin

Contributing: Glenn C. Hussey, Robert G. Gillies, Andrew W. Yau

Owner

  • Name: ICEBEAR
  • Login: icebearcanada
  • Kind: organization
  • Location: Canada

The Incoherent Continuous-wave E-Region Bistatic Experimental Auroral Radar (ICEBEAR) repository developed and maintained by the ICEBEAR team

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Eyiguler Kalafatoglu"
  given-names: "E. Ceren"
  orcid: "https://orcid.org/0000-0002-3920-3134"
- family-names: "Holley"
  given-names: "Warren"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Howarth"
  given-names: "Andrew D."
  orcid: "https://orcid.org/0000-0003-0960-2617"
- family-names: "Danskin"
  given-names: "Donald W."
  orcid: "https://orcid.org/0000-0002-4968-9094"
- family-names: "Pandey"
  given-names: "Kuldeep"
  orcid: "https://orcid.org/0000-0002-7842-2612"
- family-names: "Martin"
  given-names: "Carley J."
  orcid: "https://orcid.org/0000-0002-8278-9783"   
- family-names: "Gillies"
  given-names: "Robert G."
  orcid: "https://orcid.org/0000-0002-9116-9279"
- family-names: "Yau"
  given-names: "Andrew W."
  orcid: "https://orcid.org/0000-0002-8210-0392"
- family-names: "Hussey"
  given-names: "Glenn C."
  orcid: "https://orcid.org/0000-0003-0422-8099"            
title: "cavsiopy"
version: 1.2.2
doi: 10.5281/zenodo.8382041
date-released: 2023-09-26
url: "https://github.com/icebearcanada/cavsiopy"

GitHub Events

Total
Last Year

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 57 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
  • Total maintainers: 1
pypi.org: cavsiopy

A Python package to Calculate and Visualize Spacecraft Instrument Orientation

  • Homepage: https://github.com/icebearcanada/cavsiopy
  • Documentation: https://readthedocs.org/projects/cavsiopy/
  • License: GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
  • Latest release: 1.2.2
    published over 2 years ago
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 57 Last month
Rankings
Dependent packages count: 7.4%
Forks count: 30.4%
Average: 32.4%
Stargazers count: 39.3%
Dependent repos count: 52.5%
Maintainers (1)
ceren
Last synced: 7 months ago

Dependencies

pyproject.toml pypi
requirements.txt pypi
  • astropy ==5.1
  • geopy ==2.4.0
  • h5py ==3.9.0
  • matplotlib ==3.7.2
  • numpy ==1.25.2
  • pysofa2 ==18.1.30.8