ship examples with package

2024-12-24 19:04:02 +08:00 · 2016-04-05 13:51:45 +08:00 · 2016-04-05 13:51:45 +08:00 · cff01274e9
commit cff01274e9
parent f4c5403803
24 changed files with 15 additions and 5 deletions
--- 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
--- 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
--- a/artiq/examples/artiq_ipython_notebook.ipynb
+++ b/artiq/examples/artiq_ipython_notebook.ipynb
--- a/artiq/examples/master/device_db.pyon
+++ b/artiq/examples/master/device_db.pyon
--- a/artiq/examples/master/repository/arguments_demo.py
+++ b/artiq/examples/master/repository/arguments_demo.py
--- a/artiq/examples/master/repository/coredevice_examples/pdq2_simple.py
+++ b/artiq/examples/master/repository/coredevice_examples/pdq2_simple.py
--- a/artiq/examples/master/repository/coredevice_examples/photon_histogram.py
+++ b/artiq/examples/master/repository/coredevice_examples/photon_histogram.py
--- a/artiq/examples/master/repository/coredevice_examples/simple/ad5360.py
+++ b/artiq/examples/master/repository/coredevice_examples/simple/ad5360.py
--- a/artiq/examples/master/repository/coredevice_examples/simple/blink_forever.py
+++ b/artiq/examples/master/repository/coredevice_examples/simple/blink_forever.py
--- a/artiq/examples/master/repository/coredevice_examples/simple/dds_test.py
+++ b/artiq/examples/master/repository/coredevice_examples/simple/dds_test.py
--- a/artiq/examples/master/repository/coredevice_examples/simple/handover.py
+++ b/artiq/examples/master/repository/coredevice_examples/simple/handover.py
--- a/artiq/examples/master/repository/coredevice_examples/simple/mandelbrot.py
+++ b/artiq/examples/master/repository/coredevice_examples/simple/mandelbrot.py
--- a/artiq/examples/master/repository/coredevice_examples/tdr.py
+++ b/artiq/examples/master/repository/coredevice_examples/tdr.py
--- a/artiq/examples/master/repository/coredevice_examples/transport.py
+++ b/artiq/examples/master/repository/coredevice_examples/transport.py
--- a/artiq/examples/master/repository/flopping_f_simulation.py
+++ b/artiq/examples/master/repository/flopping_f_simulation.py
--- a/artiq/examples/master/repository/histograms.py
+++ b/artiq/examples/master/repository/histograms.py
--- a/artiq/examples/master/repository/run_forever.py
+++ b/artiq/examples/master/repository/run_forever.py
--- a/artiq/examples/master/repository/speed_benchmark.py
+++ b/artiq/examples/master/repository/speed_benchmark.py
--- a/artiq/examples/master/repository/utilities/dds_setter.py
+++ b/artiq/examples/master/repository/utilities/dds_setter.py
--- a/artiq/examples/master/repository/utilities/terminate_all.py
+++ b/artiq/examples/master/repository/utilities/terminate_all.py
--- a/artiq/examples/sim/al_spectroscopy.py
+++ b/artiq/examples/sim/al_spectroscopy.py
--- a/artiq/examples/sim/device_db.pyon
+++ b/artiq/examples/sim/device_db.pyon
--- a/artiq/examples/sim/simple_simulation.py
+++ b/artiq/examples/sim/simple_simulation.py
--- 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?
 --------------------------------------------------------