artiq/doc/manual/core_language_reference.rst

Core language reference
=======================

The most commonly used features from the ARTIQ language modules and from the core device modules are bundled together in ``artiq.experiment`` and can be imported with ``from artiq.experiment import *``.

:mod:`artiq.language.core` module
---------------------------------

.. automodule:: artiq.language.core
    :members:

:mod:`artiq.language.environment` module
----------------------------------------

.. automodule:: artiq.language.environment
    :members:

:mod:`artiq.language.scan` module
----------------------------------------

.. automodule:: artiq.language.scan
    :members:

:mod:`artiq.language.units` module
----------------------------------

This module contains floating point constants that correspond to common physical units (ns, MHz, ...).
They are provided for convenience (e.g write ``MHz`` instead of ``1000000.0``) and code clarity purposes.
doc: add sphinx infrastructure 2014-09-18 17:45:54 +08:00			`Core language reference`
			`=======================`

artiq.experiment: merge language and coredevice namespaces perl -i -pe 's/^from artiq import \$/from artiq.experiment import /' your_experiments/*.py (assuming you skipped the changes form the previous commit) 2016-01-26 06:49:08 +08:00			The most commonly used features from the ARTIQ language modules and from the core device modules are bundled together in ``artiq.experiment`` and can be imported with ``from artiq.experiment import *``.
doc/manual: minor fixes 2014-12-02 19:23:15 +08:00
doc: add sphinx infrastructure 2014-09-18 17:45:54 +08:00			:mod:`artiq.language.core` module
			`---------------------------------`

			`.. automodule:: artiq.language.core`
devices/rtio_core: rename RTIOCounter to RTIOIn and document 2014-09-30 16:42:07 +08:00			`:members:`
language/units: cleanup and add docstrings 2014-09-29 23:41:37 +08:00
refactor ddb/pdb/rdb 2015-07-14 04:08:20 +08:00			:mod:`artiq.language.environment` module
			`----------------------------------------`
language: replace AutoContext 'parameter' string with abstract attributes This allows specifying default values for parameters, and other data. 2014-12-02 17:19:05 +08:00
refactor ddb/pdb/rdb 2015-07-14 04:08:20 +08:00			`.. automodule:: artiq.language.environment`
language: replace AutoContext 'parameter' string with abstract attributes This allows specifying default values for parameters, and other data. 2014-12-02 17:19:05 +08:00			`:members:`

doc: scans 2015-08-21 13:32:53 +08:00			:mod:`artiq.language.scan` module
			`----------------------------------------`

			`.. automodule:: artiq.language.scan`
			`:members:`

language/units: cleanup and add docstrings 2014-09-29 23:41:37 +08:00			:mod:`artiq.language.units` module
doc: update patching instructions 2014-10-11 13:00:06 +08:00			`----------------------------------`
language/units: cleanup and add docstrings 2014-09-29 23:41:37 +08:00
doc: units 2015-08-18 23:31:06 +08:00			`This module contains floating point constants that correspond to common physical units (ns, MHz, ...).`
			They are provided for convenience (e.g write ``MHz`` instead of ``1000000.0``) and code clarity purposes.