Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
added README.txt to all example files
Browse files Browse the repository at this point in the history
  • Loading branch information
cwishard committed Feb 9, 2023
1 parent 7600221 commit a066a97
Show file tree
Hide file tree
Showing 13 changed files with 147 additions and 6 deletions.
3 changes: 2 additions & 1 deletion examples/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
!helio_gr_test
!whm_gr_test
!Chambers2013
!solar_impact
!solar_impact
!Swifter_Swiftest
3 changes: 1 addition & 2 deletions examples/Basic_Simulation/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
!.gitignore
!initial_conditions.py
!output_reader.py
!run_from_file.py
!read_old_run.py
!README.txt
23 changes: 23 additions & 0 deletions examples/Basic_Simulation/README.txt
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion examples/Chambers2013/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
*
!.gitignore
!init_cond.py
!scattermovie.py
!scattermovie.py
!README.txt
23 changes: 23 additions & 0 deletions examples/Chambers2013/README.txt
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions examples/Fragmentation/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
!.gitignore
!Fragmentation_Movie.py
!Multibody_Movie.py
!swiftest_fragmentation.py
!README.txt
23 changes: 23 additions & 0 deletions examples/Fragmentation/README.txt
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion examples/helio_gr_test/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*
!.gitignore
!helio_gr_test.py
!helio_gr_test.py
!README.txt
22 changes: 22 additions & 0 deletions examples/helio_gr_test/README.txt
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions examples/solar_impact/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*
!.gitignore
!sundiver.py
!README.txt
22 changes: 22 additions & 0 deletions examples/solar_impact/README.txt
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion examples/whm_gr_test/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*
!.gitignore
!whm_gr_test.py
!whm_gr_test.py
!README.txt
22 changes: 22 additions & 0 deletions examples/whm_gr_test/README.txt
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a066a97

Please sign in to comment.