ship examples with package

m-labs · Apr 5, 2016 · cff0127 · cff0127
1 parent f4c5403
commit cff0127
Showing 24 changed files with 15 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,11 +18,11 @@ __pycache__/
 
 /artiq/test/results
 /artiq/test/h5types.h5
-/examples/master/results
-/examples/master/last_rid.pyon
-/examples/master/dataset_db.pyon
-/examples/sim/results
-/examples/sim/dataset_db.pyon
+/artiq/examples/master/results
+/artiq/examples/master/last_rid.pyon
+/artiq/examples/master/dataset_db.pyon
+/artiq/examples/sim/results
+/artiq/examples/sim/dataset_db.pyon
 
 # recommended location for testbed
 /run

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,5 @@
 graft artiq/runtime
+graft artiq/examples
 include artiq/gui/logo.svg
 include versioneer.py
 include artiq/_version.py
diff --git a/examples/artiq_ipython_notebook.ipynb → artiq/examples/artiq_ipython_notebook.ipynb b/examples/artiq_ipython_notebook.ipynb → artiq/examples/artiq_ipython_notebook.ipynb
diff --git a/examples/master/device_db.pyon → artiq/examples/master/device_db.pyon b/examples/master/device_db.pyon → artiq/examples/master/device_db.pyon
diff --git a/examples/master/repository/arguments_demo.py → ...mples/master/repository/arguments_demo.py b/examples/master/repository/arguments_demo.py → ...mples/master/repository/arguments_demo.py
diff --git a/...sitory/coredevice_examples/pdq2_simple.py → ...sitory/coredevice_examples/pdq2_simple.py b/...sitory/coredevice_examples/pdq2_simple.py → ...sitory/coredevice_examples/pdq2_simple.py
diff --git a/...y/coredevice_examples/photon_histogram.py → ...y/coredevice_examples/photon_histogram.py b/...y/coredevice_examples/photon_histogram.py → ...y/coredevice_examples/photon_histogram.py
diff --git a/...tory/coredevice_examples/simple/ad5360.py → ...tory/coredevice_examples/simple/ad5360.py b/...tory/coredevice_examples/simple/ad5360.py → ...tory/coredevice_examples/simple/ad5360.py
diff --git a/...redevice_examples/simple/blink_forever.py → ...redevice_examples/simple/blink_forever.py b/...redevice_examples/simple/blink_forever.py → ...redevice_examples/simple/blink_forever.py
diff --git a/...ry/coredevice_examples/simple/dds_test.py → ...ry/coredevice_examples/simple/dds_test.py b/...ry/coredevice_examples/simple/dds_test.py → ...ry/coredevice_examples/simple/dds_test.py
diff --git a/...ry/coredevice_examples/simple/handover.py → ...ry/coredevice_examples/simple/handover.py b/...ry/coredevice_examples/simple/handover.py → ...ry/coredevice_examples/simple/handover.py
diff --git a/.../coredevice_examples/simple/mandelbrot.py → .../coredevice_examples/simple/mandelbrot.py b/.../coredevice_examples/simple/mandelbrot.py → .../coredevice_examples/simple/mandelbrot.py
diff --git a/...ter/repository/coredevice_examples/tdr.py → ...ter/repository/coredevice_examples/tdr.py b/...ter/repository/coredevice_examples/tdr.py → ...ter/repository/coredevice_examples/tdr.py
diff --git a/...pository/coredevice_examples/transport.py → ...pository/coredevice_examples/transport.py b/...pository/coredevice_examples/transport.py → ...pository/coredevice_examples/transport.py
diff --git a/...aster/repository/flopping_f_simulation.py → ...aster/repository/flopping_f_simulation.py b/...aster/repository/flopping_f_simulation.py → ...aster/repository/flopping_f_simulation.py
diff --git a/examples/master/repository/histograms.py → .../examples/master/repository/histograms.py b/examples/master/repository/histograms.py → .../examples/master/repository/histograms.py
diff --git a/examples/master/repository/run_forever.py → ...examples/master/repository/run_forever.py b/examples/master/repository/run_forever.py → ...examples/master/repository/run_forever.py
diff --git a/...ples/master/repository/speed_benchmark.py → ...ples/master/repository/speed_benchmark.py b/...ples/master/repository/speed_benchmark.py → ...ples/master/repository/speed_benchmark.py
diff --git a/...master/repository/utilities/dds_setter.py → ...master/repository/utilities/dds_setter.py b/...master/repository/utilities/dds_setter.py → ...master/repository/utilities/dds_setter.py
diff --git a/...ter/repository/utilities/terminate_all.py → ...ter/repository/utilities/terminate_all.py b/...ter/repository/utilities/terminate_all.py → ...ter/repository/utilities/terminate_all.py
diff --git a/examples/sim/al_spectroscopy.py → artiq/examples/sim/al_spectroscopy.py b/examples/sim/al_spectroscopy.py → artiq/examples/sim/al_spectroscopy.py
diff --git a/examples/sim/device_db.pyon → artiq/examples/sim/device_db.pyon b/examples/sim/device_db.pyon → artiq/examples/sim/device_db.pyon
diff --git a/examples/sim/simple_simulation.py → artiq/examples/sim/simple_simulation.py b/examples/sim/simple_simulation.py → artiq/examples/sim/simple_simulation.py
diff --git a/doc/manual/faq.rst b/doc/manual/faq.rst
@@ -6,6 +6,15 @@ FAQ
 How do I ...
 ============
 
+find ARTIQ examples?
+--------------------
+
+The examples are installed in the ``examples`` folder of the ARTIQ package. You can find where the ARTIQ package is installed on your machine with: ::
+
+  python3.5 -c "import artiq; print(artiq.__path__[0])"
+
+Copy the ``examples`` folder from that path into your home/user directory, and start experimenting!
+
 prevent my first RTIO command from causing an underflow?
 --------------------------------------------------------