From c22dc2475ec288a2a7079fa68bae25599cc33add Mon Sep 17 00:00:00 2001 From: Carlisle Wishard Date: Fri, 10 Feb 2023 15:06:26 -0500 Subject: [PATCH] moved multibody movie making example to its own directory --- examples/Fragmentation/.gitignore | 1 - examples/Fragmentation/README.txt | 5 ++--- examples/Multibody_Fragmentation/.gitignore | 4 ++++ .../Multibody_Movie.py | 17 +++++++++++---- examples/Multibody_Fragmentation/README.txt | 21 +++++++++++++++++++ 5 files changed, 40 insertions(+), 8 deletions(-) create mode 100644 examples/Multibody_Fragmentation/.gitignore rename examples/{Fragmentation => Multibody_Fragmentation}/Multibody_Movie.py (91%) create mode 100644 examples/Multibody_Fragmentation/README.txt diff --git a/examples/Fragmentation/.gitignore b/examples/Fragmentation/.gitignore index 429a2e91a..2828073f0 100644 --- a/examples/Fragmentation/.gitignore +++ b/examples/Fragmentation/.gitignore @@ -1,6 +1,5 @@ * !.gitignore !Fragmentation_Movie.py -!Multibody_Movie.py !swiftest_fragmentation.py !README.txt diff --git a/examples/Fragmentation/README.txt b/examples/Fragmentation/README.txt index 59ccaf7c1..c37f52296 100644 --- a/examples/Fragmentation/README.txt +++ b/examples/Fragmentation/README.txt @@ -17,7 +17,6 @@ Included in the Fragmentation example directory are the following files: - README.txt : This file - swiftest_fragmentation.py : A Python Script that generates and runs three sets of initial conditions. - - Fragmentation_Movie.py : A Python Script that processes an out.nc file and generates a movie (.mp4) of a collisional event. - - Multibody_Movie.py : A Python Script that processes an out.nc file and generates a movie (.mp4) of a multi-body collisional event. + - Fragmentation_Movie.py : A Python Script that processes a data.nc file and generates a movie (.mp4) of a collisional event. -This example is intendedto be run with Swiftest SyMBA. For details on how to generate, run, and analyze this example, see the Swiftest User Manual. \ No newline at end of file +This example is intended to be run with Swiftest SyMBA. For details on how to generate, run, and analyze this example, see the Swiftest User Manual. \ No newline at end of file diff --git a/examples/Multibody_Fragmentation/.gitignore b/examples/Multibody_Fragmentation/.gitignore new file mode 100644 index 000000000..54ba728dc --- /dev/null +++ b/examples/Multibody_Fragmentation/.gitignore @@ -0,0 +1,4 @@ +* +!.gitignore +!Multibody_Movie.py +!README.txt diff --git a/examples/Fragmentation/Multibody_Movie.py b/examples/Multibody_Fragmentation/Multibody_Movie.py similarity index 91% rename from examples/Fragmentation/Multibody_Movie.py rename to examples/Multibody_Fragmentation/Multibody_Movie.py index 60ca365fe..7c3d28359 100755 --- a/examples/Fragmentation/Multibody_Movie.py +++ b/examples/Multibody_Fragmentation/Multibody_Movie.py @@ -11,16 +11,25 @@ """ """ -Generates a movie of a multi-body fragmentation event from set of Swiftest output files. +Generates, runs, and processes a set of initial conditions for a multi-body super-catastrophic distruption collisional event. +All Swiftest output files are stored in the /supercatastrophic_multi subdirectory. Inputs _______ -param.in : ASCII Swiftest parameter input file. -data.nc : A NetCDF file containing the simulation output. +None. Returns ------- -fragmentation.mp4 : A .mp4 file of a fragmentation event. +supercatastrophic_multi.mp4 : A .mp4 file of a fragmentation event. +collisions.log : An ASCII file containing the information of any collisional events that occured. +collisions.nc : A NetCDF file containing the collision output. +data.nc : A NetCDF file containing the simulation output. +encounters.nc : A NetCDF file containing the encounters output. +init_cond.nc : A NetCDF file containing the initial conditions for the simulation. +param.00....in : A series of parameter input files containing the parameters for the simulation at every output stage. +param.in : An ASCII file containing the inital parameters for the simulation. +param.restart.in : An ASCII file containing the parameters for the simulation at the last output. +swiftest.log : An ASCII file containing the information on the status of the simulation as it runs. """ import swiftest diff --git a/examples/Multibody_Fragmentation/README.txt b/examples/Multibody_Fragmentation/README.txt new file mode 100644 index 000000000..9062634ca --- /dev/null +++ b/examples/Multibody_Fragmentation/README.txt @@ -0,0 +1,21 @@ +Copyright 2023 - David Minton, Carlisle Wishard, Jennifer Pouplin, Jake Elliott, & Dana Singh +This file is part of Swiftest. +Swiftest is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License +as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +Swiftest is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty +of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +You should have received a copy of the GNU General Public License along with Swiftest. +If not, see: https://www.gnu.org/licenses. + +README.txt + +Swiftest Example : Fragmentation +Author : David Minton and Carlisle Wishard +Date : December 6, 2022 + +Included in the Fragmentation example directory are the following files: + + - README.txt : This file + - Multibody_Movie.py : A Python Script that generates, runs, and processes a multi-body collisional event. + +This example is intended to be run with Swiftest SyMBA. For details on how to generate, run, and analyze this example, see the Swiftest User Manual. \ No newline at end of file