From a2c76ceb74bc3d6f2b65e301322133f7647664cc Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Tue, 8 May 2018 08:16:36 +1000
Subject: [PATCH] Organise examples

---
 README.md                                                    | 5 +++++
 .../{ => MCMC_examples}/fully_coherent_search_using_MCMC.py  | 0
 .../{ => MCMC_examples}/semi_coherent_search_using_MCMC.py   | 0
 .../semi_coherent_directed_follow_up.py                      | 0
 examples/{ => other_examples}/using_initialisation.py        | 0
 5 files changed, 5 insertions(+)
 rename examples/{ => MCMC_examples}/fully_coherent_search_using_MCMC.py (100%)
 rename examples/{ => MCMC_examples}/semi_coherent_search_using_MCMC.py (100%)
 rename examples/{ => followup_examples}/semi_coherent_directed_follow_up.py (100%)
 rename examples/{ => other_examples}/using_initialisation.py (100%)

diff --git a/README.md b/README.md
index 7394094..7e51680 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@ continuous gravitational wave (CW) searches.
 
 For documentation, please use the [wiki](https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat/wikis/home).
 
+In the
+[examples](https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat/tree/master/examples),
+we have a number of scripts demonstrating different use cases.
+
+
 ## Installation
 
 ### `python` installation
diff --git a/examples/fully_coherent_search_using_MCMC.py b/examples/MCMC_examples/fully_coherent_search_using_MCMC.py
similarity index 100%
rename from examples/fully_coherent_search_using_MCMC.py
rename to examples/MCMC_examples/fully_coherent_search_using_MCMC.py
diff --git a/examples/semi_coherent_search_using_MCMC.py b/examples/MCMC_examples/semi_coherent_search_using_MCMC.py
similarity index 100%
rename from examples/semi_coherent_search_using_MCMC.py
rename to examples/MCMC_examples/semi_coherent_search_using_MCMC.py
diff --git a/examples/semi_coherent_directed_follow_up.py b/examples/followup_examples/semi_coherent_directed_follow_up.py
similarity index 100%
rename from examples/semi_coherent_directed_follow_up.py
rename to examples/followup_examples/semi_coherent_directed_follow_up.py
diff --git a/examples/using_initialisation.py b/examples/other_examples/using_initialisation.py
similarity index 100%
rename from examples/using_initialisation.py
rename to examples/other_examples/using_initialisation.py
-- 
GitLab