.. WARNING: DO NOT EDIT THIS FILE. IT IS OVERWRITTEN DURING DOCUMENTATION CONSTRUCTION.  SEE /docs/scripts/write_example_docs.py FOR MORE INFORMATION ABOUT THIS FILE.

.. module:: examples



Examples
==========================================================
Some example analyses based on ngEHTforecast illustrating its capabilities and
how to make use of them are contained in the **examples** folder.  If you generate
an analysis, we encourage you to upload it with a short description of what it
does in the docstring for other ngEHTforecast users!  Please ensure that your
analysis is behind the standard __name__ check, i.e.,

::
   
   """
   Short description of your analysis that will appear in documentation.
   """
   
   [Top level import statements]
   
   if __name__ == "__main__" :
       [The bulk of your analysis code, including any outputs and
       anything that takes more than a few seconds to run.]

All Python scripts in **examples** conforming to the above will appear in the
documentation the next time it is made!



examples/binary_example.py
---------------------------------------------------
.. automodule:: examples.binary_example
   :members:


examples/ring_example.py
---------------------------------------------------
.. automodule:: examples.ring_example
   :members: