diff --git a/examples/.gitignore b/examples/.gitignore index 151c4c774..226807ea0 100644 --- a/examples/.gitignore +++ b/examples/.gitignore @@ -5,4 +5,5 @@ !helio_gr_test !whm_gr_test !Chambers2013 -!solar_impact \ No newline at end of file +!solar_impact +!Swifter_Swiftest diff --git a/examples/Basic_Simulation/.gitignore b/examples/Basic_Simulation/.gitignore index 0a4af3872..728fe8873 100644 --- a/examples/Basic_Simulation/.gitignore +++ b/examples/Basic_Simulation/.gitignore @@ -2,5 +2,4 @@ !.gitignore !initial_conditions.py !output_reader.py -!run_from_file.py -!read_old_run.py +!README.txt diff --git a/examples/Basic_Simulation/README.txt b/examples/Basic_Simulation/README.txt new file mode 100644 index 000000000..9db2d5f54 --- /dev/null +++ b/examples/Basic_Simulation/README.txt @@ -0,0 +1,23 @@ +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 : Basic_Simulation +Author : Carlisle Wishard and David Minton +Date : December 6, 2022 + +Included in the Basic_Simulation example directory are the following files: + + - README.txt : This file + - initial_conditions.py : A Python Script that generates and runs a set of initial conditions. + - output_reader.py : A Python Script that processes out.nc and generates output.eps + +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/Chambers2013/.gitignore b/examples/Chambers2013/.gitignore index 48025297e..64af50e94 100644 --- a/examples/Chambers2013/.gitignore +++ b/examples/Chambers2013/.gitignore @@ -1,4 +1,5 @@ * !.gitignore !init_cond.py -!scattermovie.py \ No newline at end of file +!scattermovie.py +!README.txt diff --git a/examples/Chambers2013/README.txt b/examples/Chambers2013/README.txt new file mode 100644 index 000000000..e160232c0 --- /dev/null +++ b/examples/Chambers2013/README.txt @@ -0,0 +1,23 @@ +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 : Chambers2013 +Author : David Minton and Carlisle Wishard +Date : December 6, 2022 + +Included in the Chambers2013 example directory are the following files: + + - README.txt : This file + - init_cond.py : A Python Script that generates and runs a set of initial conditions. + - scattermovie.py : A Python Script that processes out.nc and generates Chambers2013-aescatter.mp4 or Chambers2013-aiscatter.mp4 + +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/Fragmentation/.gitignore b/examples/Fragmentation/.gitignore index 2105da1cb..429a2e91a 100644 --- a/examples/Fragmentation/.gitignore +++ b/examples/Fragmentation/.gitignore @@ -2,3 +2,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 new file mode 100644 index 000000000..59ccaf7c1 --- /dev/null +++ b/examples/Fragmentation/README.txt @@ -0,0 +1,23 @@ +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 + - 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. + +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 diff --git a/examples/helio_gr_test/.gitignore b/examples/helio_gr_test/.gitignore index 8968b5dd7..7e1c9b544 100644 --- a/examples/helio_gr_test/.gitignore +++ b/examples/helio_gr_test/.gitignore @@ -1,3 +1,4 @@ * !.gitignore -!helio_gr_test.py \ No newline at end of file +!helio_gr_test.py +!README.txt diff --git a/examples/helio_gr_test/README.txt b/examples/helio_gr_test/README.txt new file mode 100644 index 000000000..e14ab2747 --- /dev/null +++ b/examples/helio_gr_test/README.txt @@ -0,0 +1,22 @@ +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 : helio_gr_test +Author : David Minton and Carlisle Wishard +Date : December 6, 2022 + +Included in the helio_gr_test example directory are the following files: + + - README.txt : This file + - helio_gr_test.py : A Python Script that generates and runs a set of initial conditions. + +This example is intended to be run with Swiftest HELIO. 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/solar_impact/.gitignore b/examples/solar_impact/.gitignore index bb6bbd922..5148ba3a2 100644 --- a/examples/solar_impact/.gitignore +++ b/examples/solar_impact/.gitignore @@ -1,3 +1,4 @@ * !.gitignore !sundiver.py +!README.txt diff --git a/examples/solar_impact/README.txt b/examples/solar_impact/README.txt new file mode 100644 index 000000000..fe8cc1e80 --- /dev/null +++ b/examples/solar_impact/README.txt @@ -0,0 +1,22 @@ +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 : solar_impact +Author : David Minton and Carlisle Wishard +Date : December 6, 2022 + +Included in the solar_impact example directory are the following files: + + - README.txt : This file + - sundiver.py : A Python Script that generates and runs a set of initial conditions. + +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/whm_gr_test/.gitignore b/examples/whm_gr_test/.gitignore index 1463c046c..738e3fe63 100644 --- a/examples/whm_gr_test/.gitignore +++ b/examples/whm_gr_test/.gitignore @@ -1,3 +1,4 @@ * !.gitignore -!whm_gr_test.py \ No newline at end of file +!whm_gr_test.py +!README.txt diff --git a/examples/whm_gr_test/README.txt b/examples/whm_gr_test/README.txt new file mode 100644 index 000000000..82549c927 --- /dev/null +++ b/examples/whm_gr_test/README.txt @@ -0,0 +1,22 @@ +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 : whm_gr_test +Author : David Minton and Carlisle Wishard +Date : December 6, 2022 + +Included in the whm_gr_test example directory are the following files: + + - README.txt : This file + - whm_gr_test.py : A Python Script that generates and runs a set of initial conditions. + +This example is intended to be run with Swiftest WHM. For details on how to generate, run, and analyze this example, +see the Swiftest User Manual. \ No newline at end of file