Updating Readme.

JPGlaser · Feb 17, 2020 · 9aa4bb6 · 9aa4bb6
1 parent 52fa7e1
commit 9aa4bb6
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
 # Tycho
 AMUSE community code for observing star-star scattering effects on exoplanets in stellar clusters.
+
+TYCHO is a simulation suite used in observing the effects of star-star scattering on exoplanets within clustered natal environments. It is dependent on multiple community codes provided by the Astrophysical Multipurpose Software Environment (AMUSE; amusecode.org).
+
+Breakdown of Files:
+    - sim_cluster.py ~ Used in simulating a star cluster and record all close-encounters.
+    - sim_encounters.py ~ Used in simulating stellar close-encounters created and stored by sim_cluster.py
+    - plot_encounters.py ~ Used to plot stellar close-encounters.
diff --git a/src/tycho/__init__.pyc b/src/tycho/__init__.pyc
diff --git a/src/tycho/create.pyc b/src/tycho/create.pyc
diff --git a/src/tycho/encounter_db.pyc b/src/tycho/encounter_db.pyc
diff --git a/src/tycho/multiples2.pyc b/src/tycho/multiples2.pyc
diff --git a/src/tycho/read.pyc b/src/tycho/read.pyc
diff --git a/src/tycho/util.pyc b/src/tycho/util.pyc
diff --git a/src/tycho/write.pyc b/src/tycho/write.pyc