add some visualisation functionality #111

astjoephysics · 2025-04-04T15:57:59Z

Beginning of #17. Adds some barebones visualisation functionality. Can take in a .csv (and I assume .hdf5, although I haven't tested it) of orbits (assuming BKEP input) and plot orbits in either plotly or matplot (default to matplot).

WIP, needs orbit conversion functionality and actual command line inputs + any tidying up of code.

blah

update branch

update remote branch

astjoephysics · 2025-05-02T21:54:38Z

Currently added:

2D matplot plotting with flags for:

describing what planet orbits you want plotted (must be in form 'Me', 'V', 'E', 'Ma', 'J', 'S', 'U', 'N', basic circular orbit assumed for now)
turning on or off the sun, planets
turning on or off the object orbits being faded

3D matplot plotting with all of above
3D plotly plotting

Todo:

Add functionality to convert orbit types. Currently assumed BKEP input orbit type so will need to check input file for orbit format and convert if necessary

mschwamb · 2025-05-08T06:37:31Z

src/layup/visualize.py

+    import matplotlib.pyplot as plt
+    from matplotlib.collections import LineCollection
+
+    plt.style.use("./src/layup/matplot2d.mplstyle")


I think in the package content we can't import like this. Is that right, @drewoldag ? Do you suggestions?

astjoephysics · 2025-05-08T17:15:49Z

the mpl style file should be edited so that there is a function that takes in the figure axes and sets up the plotting visual tools

mschwamb · 2025-05-22T17:42:35Z

@bernardinelli says he's on deck to review this when he has time post this talk at a conference this week

bernardinelli · 2025-05-06T22:02:55Z

src/layup/visualize.py

+        axs[1].add_collection(lc)
+
+    # add the sun
+    if not no_sun:


Nitpicking, because I've made this mistake before: instead of using if not no_sun, wouldn't it be better to just check if sun? xD

bernardinelli · 2025-05-06T22:04:00Z

src/layup/visualize.py

+    import matplotlib.pyplot as plt
+    from mpl_toolkits.mplot3d.art3d import Line3DCollection
+
+    fig = plt.figure(figsize=(15, 9))


I'd suggest instead of creating the figure and axis object, we could have the user send their own too. For example, if I want to use my own plot style, or plot other things in parallel

bernardinelli · 2025-05-30T11:45:44Z

src/layup/visualize.py

+    # mean anomaly via fixed point iteration and then wrap the linspace
+    # around this value from 0 to 2pi
+    E_init = M  # initial guesses using mean anomaly (shouldn't be too far off)
+


Should assert e<1 here

bernardinelli · 2025-05-30T11:48:38Z

src/layup/visualize.py

+        "axes.titlesize": 32,
+    }
+)
+def matplot_2D(orb_array, planets, no_planets, no_sun, output, fade):


I still think it’s a bad idea to create and destroy the Matplotlib fig and ax objects inside the function entirely. For the CLI, this can be done outside the function call, these objects passed and then closed afterwards, as it doesn’t matter. But allowing me to pass and close my own object is a lot more flexible, as I can add other things I want to my own figure

In the same spirit as before, I think that the Matplotlib rc parameters should only be changed if I’m using the CLI, I think it’s rude to change those otherwise (eg I use my own custom set of parameters)

(A better implementation option than what I suggested earlier for the fig and axs business is to have them be None as defaults, and instantiate them if they’re none)

…t and sun plotting

astjoephysics · 2025-10-23T17:23:03Z

Also begins to addresses the hyperbolic orbit stuff from #18 in lines 168-170

Little-Ryugu · 2025-10-28T13:27:31Z

src/layup_cmdline/visualize.py

        sys.exit("ERROR: File format must be 'csv' or 'hdf5'")

+    # check for overwriting output file
+    warn_or_remove_file(str(output_file), args.force, logger)


The force command -f doesn't work. The output files are defined as output.csv or output.h5 for the args.force check instead of checking for output.png in the function warn_or_remove_files.

layup/src/layup_cmdline/visualize.py

Lines 124 to 130 in ef98cb1

if args.i.lower() == "csv":

output_file = args.o + ".csv"

elif args.i.lower() == "hdf5":

output_file = args.o + ".h5"

else:

sys.exit("ERROR: File format must be 'csv' or 'hdf5'")

Little-Ryugu · 2025-10-28T13:27:40Z

src/layup_cmdline/visualize.py

        default="csv",
        required=False,
    )
+    optional.add_argument(


When --orbit_type is not called in cmd line, args.orbit_type defaults to None. then it's called as None in:

layup/src/layup_cmdline/visualize.py

Lines 144 to 155 in ef98cb1

visualize_cli(

input=args.input,

output_file_stem=args.o,

planets=args.planets,

input_format=args.orbit_type,

backend=args.b,

dimensions=args.d,

num_orbs=args.n,

plot_planets=args.plot_planets,

plot_sun=args.plot_sun,

fade=args.fade,

)

and this default value being set in visualize_cli is ignored

layup/src/layup/visualize.py

Line 510 in ef98cb1

input_format: Literal["BCART", "BCOM", "BKEP", "CART", "COM", "KEP"] = "BKEP",

add some visualisation functionality

b3de7f3

mschwamb changed the title ~~add some visualisation functionality~~ WIP - add some visualisation functionality Apr 9, 2025

astjoephysics mentioned this pull request Apr 28, 2025

Add command line structure for visualise #154

Closed

astjoephysics added 7 commits April 28, 2025 16:21

Merge remote-tracking branch 'origin/main' into layup_visualise

e3c78ee

blah

Merge remote-tracking branch 'origin/main' into layup_visualise

d9da5f5

update branch

Merge remote-tracking branch 'origin/main' into layup_visualise

54ac092

update remote branch

update CLI plotting functionality

2a1f987

lint the files

03841d6

lint file

7793c19

remove old file

ab33cff

astjoephysics changed the title ~~WIP - add some visualisation functionality~~ add some visualisation functionality May 6, 2025

astjoephysics requested a review from bernardinelli May 6, 2025 13:41

mschwamb reviewed May 8, 2025

View reviewed changes

astjoephysics added 2 commits May 20, 2025 16:46

remove .mplstyle file, add same funcitonality as function decorator

1e70a38

linting

836f0b7

astjoephysics requested a review from mschwamb May 20, 2025 21:03

bernardinelli requested changes May 30, 2025

View reviewed changes

astjoephysics added 2 commits October 23, 2025 15:48

added pedro suggested changes, added some user safeguarding for plane…

ee1b810

…t and sun plotting

fixed linting

ef98cb1

mschwamb requested review from Little-Ryugu and removed request for mschwamb October 23, 2025 17:38

Little-Ryugu requested changes Oct 28, 2025

View reviewed changes

	if args.i.lower() == "csv":
	output_file = args.o + ".csv"
	elif args.i.lower() == "hdf5":
	output_file = args.o + ".h5"
	else:
	sys.exit("ERROR: File format must be 'csv' or 'hdf5'")

	visualize_cli(
	input=args.input,
	output_file_stem=args.o,
	planets=args.planets,
	input_format=args.orbit_type,
	backend=args.b,
	dimensions=args.d,
	num_orbs=args.n,
	plot_planets=args.plot_planets,
	plot_sun=args.plot_sun,
	fade=args.fade,
	)

add some visualisation functionality #111

Are you sure you want to change the base?

add some visualisation functionality #111

Uh oh!

Conversation

astjoephysics commented Apr 4, 2025

Uh oh!

astjoephysics commented May 2, 2025

Uh oh!

mschwamb May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astjoephysics commented May 8, 2025

Uh oh!

mschwamb commented May 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astjoephysics commented Oct 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mschwamb May 8, 2025 •

edited

Loading