artiq/doc/manual/core_language_reference.rst
architeuthidae ab1aeb136f doc: Edit of manual reference pages (#2466)
Co-authored-by: architeuthis <am@m-labs.hk>
2024-07-18 17:54:31 +08:00

35 lines
1.1 KiB
ReStructuredText

Core language reference
=======================
The most commonly used features from the ARTIQ language modules and from the core device modules are bundled together in :mod:`artiq.experiment` and can be imported with ``from artiq.experiment import *``.
:mod:`artiq.language.core` module
---------------------------------
.. automodule:: artiq.language.core
:member-order: bysource
:members:
:mod:`artiq.language.environment` module
----------------------------------------
.. automodule:: artiq.language.environment
:member-order: bysource
:members:
:mod:`artiq.language.scan` module
----------------------------------------
.. automodule:: artiq.language.scan
:member-order: bysource
:members:
:mod:`artiq.language.units` module
----------------------------------
.. displays nothing, but makes references work
.. automodule:: artiq.language.units
:members:
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.