Skip to main content

The Orbitronomy library offers the functionality for plotting, calculating, visualizing, and animating the orbits of various celestial bodies in 3D space. It utilizes Kepler's elliptical orbit equations along with PyAstronomy for orbital calculations, and Matplotlib for 3D plotting.

Project description

Official Orbitronomy Library

The Orbitronomy library offers the functionality for plotting, calculating, visualizing, and animating the orbits of various celestial bodies in 3D space. It utilizes Kepler's elliptical orbit equations along with PyAstronomy for orbital calculations, and Matplotlib for 3D plotting.

SimpleOrbit Class

The SimpleOrbit class provides the capability of simulating single object orbits, and multiple object orbits in the format of a list within list.

Constructor

SimpleOrbit(plot_title, name)

Parameters:

  • plot_title: Title for the plot.
  • name: Identifier for the celestial body.

Methods

  • faceColor(color): Sets the face color of the axes.
  • paneColor(color): Sets the color of the 3D panes.
  • gridColor(color): Sets the grid color.
  • orbitTransparency(value): Sets the transparency of the orbits.
  • labelColor(color): Sets the color of axis labels.
  • tickColor(color): Sets the color of axis ticks.
  • plotStyle(background_color): Sets the background style of the plot.
  • semiMajorAxis(value), perihelion(value), eccentricity(value), inclination(value), longitudeOfAscendingNode(value), argumentOfPerihelion(value): Set specific orbital parameters.

Usage Example:

from orbitronomy.orbitCalcs import SimpleOrbit

test = SimpleOrbit(plot_title="Test", name="Earth")

# Styling
test.faceColor("black")
test.paneColor("black")
test.gridColor("#222831")
test.orbitTransparency(0.5)
test.labelColor("white")
test.tickColor("white")

test.plotStyle(background_color="dark_background")

# the form of the "data" list should be as follows: 
# "name", semi_major_axis, perihelion, eccentricity, inclination, longitude_of_ascending_node, argument_of_perihelion, color (optional)
data = [["object1", 1, 0.983289891, 0.01671123, 15, 0, 0, "green"], ["object2", 1.5, 0.483289891, 0.02671123, 6, 0, 0, "yellow"], ["object3", 1.3, 0.683289891, 0.01671123, 2, 0, 0, "red"]]

#you can also use the following instead of "data" array if you want to plot a single object
# test.semiMajorAxis(1)
# test.perihelion(0.983289891)
# test.eccentricity(0.01671123)
# test.inclination(0)
# test.longitudeOfAscendingNode(0)
# test.argumentOfPerihelion(0)

# Calculating and plotting orbits
test.calculateOrbit(plot_steps=1000, n_orbits=1, data=data, trajectory=True, sun=True)

#you can choose if you want to set boundaries for the plot
# test.xLim([20, 20])
# test.yLim([20, 20])
# test.zLim([0.1, 0.1])

# Setting axis labels
test.xLabel("X-Axis")
test.yLabel("Y-Axis")
test.zLabel("Z-Axis")

# Animating the orbits
test.animateOrbit(dpi=250, save=False, export_zoom=3, font_size="xx-small", export_folder="results")

Quick Documentation SimpleOrbit

Orbitronomy Library with Dataset Functionality

The Orbitronomy library is enhanced with functionality to calculate, visualize, plot, and animate orbits of celestial bodies in 3D using datasets. It utilizes Kepler's elliptical orbit equations, PyAstronomy for orbital calculations, and Matplotlib for 3D plotting.

datasetOrbit Class

The datasetOrbit class extends the capabilities of the SimpleOrbit class, allowing for the use of datasets to plot multiple celestial bodies.

Constructor

datasetOrbit(plot_title, name)

Parameters:

  • plot_title: Title for the plot.
  • name: Identifier for the celestial body or simulation.

Styling Methods

  • faceColor(color)
  • paneColor(color)
  • gridColor(color)
  • orbitTransparency(value)
  • labelColor(color)
  • tickColor(color)
  • datasetPlotStyle(background_color)

Dataset Configuration

  • columnSemiMajorAxis(column_name)
  • columnPerihelion(column_name)
  • columnEccentricity(column_name)
  • columnInclination(column_name)
  • columnLongitudeOfAscendingNode(column_name)
  • columnArgumentOfPerihelion(column_name)
  • columnColor(column_name)
  • columnName(column_name)
  • fileName(file_name)

Orbit Calculation and Animation

  • datasetCalculateOrbit(plot_steps, n_orbits, color, trajectory, sun, random_color)
  • xLim(lim), yLim(lim), zLim(lim)
  • xLabel(label), yLabel(label), zLabel(label)
  • datasetAnimateOrbit(dpi, save, export_zoom, font_size, export_folder)

Usage Example:

from orbitronomy.datasetOrbit import datasetOrbit

test = datasetOrbit(plot_title="Test", name="Earth")

# Styling
test.faceColor("black")
test.paneColor("black")
test.gridColor("#222831")
test.orbitTransparency(0.5)
test.labelColor("white")
test.tickColor("white")

test.datasetPlotStyle(background_color="dark_background")

# Dataset column configuration
test.columnSemiMajorAxis("semi_major_axis")
test.columnPerihelion("perihelion")
test.columnEccentricity("eccentricity")
test.columnInclination("inclination")
test.columnLongitudeOfAscendingNode("longitude_of_ascending_node")
test.columnArgumentOfPerihelion("argument_of_perihelion")
test.columnColor("color")
test.columnName("name")

# Specifying the dataset file name
test.fileName("datasets/Planetary-Satellite-Data.csv")

# Calculating and plotting orbits from the dataset
test.datasetCalculateOrbit(plot_steps=1000, n_orbits=12, color="yellow", random_color=True, trajectory=True, sun=True)

#you can choose if you want to set boundaries for the plot
# test.xLim([20, 20])
# test.yLim([20, 20])
# test.zLim([0.1, 0.1])

# Setting axis labels
test.xLabel("X-Axis")
test.yLabel("Y-Axis")
test.zLabel("Z-Axis")

# Animating the orbits
test.datasetAnimateOrbit(dpi=250, save=False, export_zoom=3, font_size="xx-small")

Quick Documentation datasetOrbit

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

orbitronomy-0.1.1.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

orbitronomy-0.1.1-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

Details for the file orbitronomy-0.1.1.tar.gz.

File metadata

  • Download URL: orbitronomy-0.1.1.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for orbitronomy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 55cf447fcba48b4b41e69beaade784eba7ffe85bb97d02c566901410a24c0f66
MD5 5f5d3de7e3e1e5089ad36892c10df564
BLAKE2b-256 7abb309146450645bedd9e40e8f1f039f1266c449b73079dbdcef396afe939d0

See more details on using hashes here.

File details

Details for the file orbitronomy-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: orbitronomy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 32.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for orbitronomy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72208dbe0d3ede68e1f01683623325cf8d632951e471a970e942b31dc92bab49
MD5 d3e85cea3f65b5b6083f006a5af18e8a
BLAKE2b-256 deff2d0fb460015271a050397fd4524e7c56d819908a4f88f5fd0fe4ac13a21f

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