├── .gitignore ├── .project ├── .pydevproject ├── .settings └── org.eclipse.core.resources.prefs ├── README.md ├── README.rst └── docs ├── Makefile ├── _static ├── epwave.png ├── favicon.ico ├── from_to.png ├── get_signals.png ├── openEpwaveCheckbox.png └── signal_filter.png ├── conf.py ├── faq.rst ├── index.rst ├── intro.rst ├── make.bat ├── quick-start.rst └── requirements.txt /.gitignore: -------------------------------------------------------------------------------- 1 | docs/_build 2 | -------------------------------------------------------------------------------- /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | epwave 4 | 5 | 6 | 7 | 8 | 9 | org.python.pydev.PyDevBuilder 10 | 11 | 12 | 13 | 14 | 15 | org.python.pydev.pythonNature 16 | 17 | 18 | -------------------------------------------------------------------------------- /.pydevproject: -------------------------------------------------------------------------------- 1 | 2 | 3 | Default 4 | python 2.7 5 | 6 | -------------------------------------------------------------------------------- /.settings/org.eclipse.core.resources.prefs: -------------------------------------------------------------------------------- 1 | eclipse.preferences.version=1 2 | encoding//docs/conf.py=utf-8 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | EPWave web application located at http://www.edaplayground.com/w 2 | 3 | EPWave Documentation located at http://epwave.readthedocs.org 4 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | docs/intro.rst -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | PAPER = 8 | BUILDDIR = _build 9 | 10 | # User-friendly check for sphinx-build 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) 13 | endif 14 | 15 | # Internal variables. 16 | PAPEROPT_a4 = -D latex_paper_size=a4 17 | PAPEROPT_letter = -D latex_paper_size=letter 18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 19 | # the i18n builder cannot share the environment and doctrees with the others 20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 21 | 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 23 | 24 | help: 25 | @echo "Please use \`make ' where is one of" 26 | @echo " html to make standalone HTML files" 27 | @echo " dirhtml to make HTML files named index.html in directories" 28 | @echo " singlehtml to make a single large HTML file" 29 | @echo " pickle to make pickle files" 30 | @echo " json to make JSON files" 31 | @echo " htmlhelp to make HTML files and a HTML help project" 32 | @echo " qthelp to make HTML files and a qthelp project" 33 | @echo " devhelp to make HTML files and a Devhelp project" 34 | @echo " epub to make an epub" 35 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 36 | @echo " latexpdf to make LaTeX files and run them through pdflatex" 37 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 38 | @echo " text to make text files" 39 | @echo " man to make manual pages" 40 | @echo " texinfo to make Texinfo files" 41 | @echo " info to make Texinfo files and run them through makeinfo" 42 | @echo " gettext to make PO message catalogs" 43 | @echo " changes to make an overview of all changed/added/deprecated items" 44 | @echo " xml to make Docutils-native XML files" 45 | @echo " pseudoxml to make pseudoxml-XML files for display purposes" 46 | @echo " linkcheck to check all external links for integrity" 47 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" 48 | 49 | clean: 50 | rm -rf $(BUILDDIR)/* 51 | 52 | html: 53 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 54 | @echo 55 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 56 | 57 | dirhtml: 58 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 59 | @echo 60 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 61 | 62 | singlehtml: 63 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 64 | @echo 65 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 66 | 67 | pickle: 68 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 69 | @echo 70 | @echo "Build finished; now you can process the pickle files." 71 | 72 | json: 73 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 74 | @echo 75 | @echo "Build finished; now you can process the JSON files." 76 | 77 | htmlhelp: 78 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 79 | @echo 80 | @echo "Build finished; now you can run HTML Help Workshop with the" \ 81 | ".hhp project file in $(BUILDDIR)/htmlhelp." 82 | 83 | qthelp: 84 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 85 | @echo 86 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 87 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 88 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EDAPlayground.qhcp" 89 | @echo "To view the help file:" 90 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EDAPlayground.qhc" 91 | 92 | devhelp: 93 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 94 | @echo 95 | @echo "Build finished." 96 | @echo "To view the help file:" 97 | @echo "# mkdir -p $$HOME/.local/share/devhelp/EDAPlayground" 98 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EDAPlayground" 99 | @echo "# devhelp" 100 | 101 | epub: 102 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 103 | @echo 104 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 105 | 106 | latex: 107 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 108 | @echo 109 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 110 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ 111 | "(use \`make latexpdf' here to do that automatically)." 112 | 113 | latexpdf: 114 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 115 | @echo "Running LaTeX files through pdflatex..." 116 | $(MAKE) -C $(BUILDDIR)/latex all-pdf 117 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 118 | 119 | latexpdfja: 120 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 121 | @echo "Running LaTeX files through platex and dvipdfmx..." 122 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 123 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 124 | 125 | text: 126 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 127 | @echo 128 | @echo "Build finished. The text files are in $(BUILDDIR)/text." 129 | 130 | man: 131 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 132 | @echo 133 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 134 | 135 | texinfo: 136 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 137 | @echo 138 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 139 | @echo "Run \`make' in that directory to run these through makeinfo" \ 140 | "(use \`make info' here to do that automatically)." 141 | 142 | info: 143 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 144 | @echo "Running Texinfo files through makeinfo..." 145 | make -C $(BUILDDIR)/texinfo info 146 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 147 | 148 | gettext: 149 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 150 | @echo 151 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 152 | 153 | changes: 154 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 155 | @echo 156 | @echo "The overview file is in $(BUILDDIR)/changes." 157 | 158 | linkcheck: 159 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 160 | @echo 161 | @echo "Link check complete; look for any errors in the above output " \ 162 | "or in $(BUILDDIR)/linkcheck/output.txt." 163 | 164 | doctest: 165 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 166 | @echo "Testing of doctests in the sources finished, look at the " \ 167 | "results in $(BUILDDIR)/doctest/output.txt." 168 | 169 | xml: 170 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 171 | @echo 172 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 173 | 174 | pseudoxml: 175 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 176 | @echo 177 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 178 | -------------------------------------------------------------------------------- /docs/_static/epwave.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/epwave.png -------------------------------------------------------------------------------- /docs/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/favicon.ico -------------------------------------------------------------------------------- /docs/_static/from_to.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/from_to.png -------------------------------------------------------------------------------- /docs/_static/get_signals.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/get_signals.png -------------------------------------------------------------------------------- /docs/_static/openEpwaveCheckbox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/openEpwaveCheckbox.png -------------------------------------------------------------------------------- /docs/_static/signal_filter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edaplayground/epwave/565e45ed919b85880402b546a15887f0c71eb193/docs/_static/signal_filter.png -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # EPWave documentation build configuration file, created by 4 | # sphinx-quickstart on Sun Sep 22 13:41:23 2013. 5 | # 6 | # This file is execfile()d with the current directory set to its 7 | # containing dir. 8 | # 9 | # Note that not all possible configuration values are present in this 10 | # autogenerated file. 11 | # 12 | # All configuration values have a default; values that are commented out 13 | # serve to show the default. 14 | 15 | import sys 16 | import os 17 | import sphinx_bootstrap_theme 18 | 19 | # If extensions (or modules to document with autodoc) are in another directory, 20 | # add these directories to sys.path here. If the directory is relative to the 21 | # documentation root, use os.path.abspath to make it absolute, like shown here. 22 | #sys.path.insert(0, os.path.abspath('.')) 23 | 24 | # -- General configuration ------------------------------------------------ 25 | 26 | # If your documentation needs a minimal Sphinx version, state it here. 27 | #needs_sphinx = '1.0' 28 | 29 | # Add any Sphinx extension module names here, as strings. They can be 30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31 | # ones. 32 | extensions = [] 33 | 34 | # Add any paths that contain templates here, relative to this directory. 35 | templates_path = ['_templates'] 36 | 37 | # The suffix of source filenames. 38 | source_suffix = '.rst' 39 | 40 | # The encoding of source files. 41 | #source_encoding = 'utf-8-sig' 42 | 43 | # The master toctree document. 44 | master_doc = 'index' 45 | 46 | # General information about the project. 47 | project = u'EPWave' 48 | copyright = u'2015, Doulos' 49 | 50 | # The version info for the project you're documenting, acts as replacement for 51 | # |version| and |release|, also used in various other places throughout the 52 | # built documents. 53 | # 54 | # The short X.Y version. 55 | version = '' 56 | # The full version, including alpha/beta/rc tags. 57 | release = '' 58 | 59 | # The language for content autogenerated by Sphinx. Refer to documentation 60 | # for a list of supported languages. 61 | #language = None 62 | 63 | # There are two options for replacing |today|: either, you set today to some 64 | # non-false value, then it is used: 65 | #today = '' 66 | # Else, today_fmt is used as the format for a strftime call. 67 | #today_fmt = '%B %d, %Y' 68 | 69 | # List of patterns, relative to source directory, that match files and 70 | # directories to ignore when looking for source files. 71 | exclude_patterns = ['_build'] 72 | 73 | # The reST default role (used for this markup: `text`) to use for all 74 | # documents. 75 | #default_role = None 76 | 77 | # If true, '()' will be appended to :func: etc. cross-reference text. 78 | #add_function_parentheses = True 79 | 80 | # If true, the current module name will be prepended to all description 81 | # unit titles (such as .. function::). 82 | #add_module_names = True 83 | 84 | # If true, sectionauthor and moduleauthor directives will be shown in the 85 | # output. They are ignored by default. 86 | #show_authors = False 87 | 88 | # The name of the Pygments (syntax highlighting) style to use. 89 | pygments_style = 'sphinx' 90 | 91 | # A list of ignored prefixes for module index sorting. 92 | #modindex_common_prefix = [] 93 | 94 | # If true, keep warnings as "system message" paragraphs in the built documents. 95 | #keep_warnings = False 96 | 97 | 98 | # -- Options for HTML output ---------------------------------------------- 99 | 100 | # The theme to use for HTML and HTML Help pages. See the documentation for 101 | # a list of builtin themes. 102 | html_theme = 'bootstrap' 103 | 104 | # Theme options are theme-specific and customize the look and feel of a theme 105 | # further. For a list of options available for each theme, see the 106 | # documentation. 107 | html_theme_options = { 108 | # Navigation bar title. (Default: ``project`` value) 109 | # 'navbar_title': "EPWave", 110 | 111 | # Tab name for entire site. (Default: "Site") 112 | 'navbar_site_name': "Site Contents", 113 | 114 | # A list of tuples containing pages or urls to link to. 115 | # Valid tuples should be in the following forms: 116 | # (name, page) # a link to a page 117 | # (name, "/aa/bb", 1) # a link to an arbitrary relative url 118 | # (name, "http://example.com", True) # arbitrary absolute url 119 | # Note the "1" or "True" value above as the third argument to indicate 120 | # an arbitrary url. 121 | 'navbar_links': [ 122 | ('Forum', "https://groups.google.com/forum/#!forum/eda-playground", True) 123 | ], 124 | 125 | # Render the next and previous page links in navbar. (Default: true) 126 | 'navbar_sidebarrel': True, 127 | 128 | # Render the current pages TOC in the navbar. (Default: true) 129 | 'navbar_pagenav': True, 130 | 131 | # Global TOC depth for "site" navbar tab. (Default: 1) 132 | # Switching to -1 shows all levels. 133 | 'globaltoc_depth': 2, 134 | 135 | # Include hidden TOCs in Site navbar? 136 | # 137 | # Note: If this is "false", you cannot have mixed ``:hidden:`` and 138 | # non-hidden ``toctree`` directives in the same page, or else the build 139 | # will break. 140 | # 141 | # Values: "true" (default) or "false" 142 | 'globaltoc_includehidden': "true", 143 | 144 | # HTML navbar class (Default: "navbar") to attach to
element. 145 | # For black navbar, do "navbar navbar-inverse" 146 | 'navbar_class': "navbar navbar-inverse", 147 | 148 | # Fix navigation bar to top of page? 149 | # Values: "true" (default) or "false" 150 | 'navbar_fixed_top': "true", 151 | 152 | # Location of link to source. 153 | # Options are "nav" (default), "footer" or anything else to exclude. 154 | 'source_link_position': "nav", 155 | 156 | # Bootswatch (http://bootswatch.com/) theme. 157 | # 158 | # Options are nothing with "" (default) or the name of a valid theme 159 | # such as "amelia" or "cosmo". 160 | # 161 | # Note that this is served off CDN, so won't be available offline. 162 | 'bootswatch_theme': "cerulean", 163 | 164 | # Choose Bootstrap version. 165 | # Values: "3" (default) or "2" (in quotes) 166 | 'bootstrap_version': "3", 167 | } 168 | 169 | # Add any paths that contain custom themes here, relative to this directory. 170 | html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() 171 | 172 | # The name for this set of Sphinx documents. If None, it defaults to 173 | # " v documentation". 174 | #html_title = None 175 | 176 | # A shorter title for the navigation bar. Default is the same as html_title. 177 | #html_short_title = None 178 | 179 | # The name of an image file (relative to this directory) to place at the top 180 | # of the sidebar. 181 | #html_logo = None 182 | 183 | # The name of an image file (within the static path) to use as favicon of the 184 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 185 | # pixels large. 186 | html_favicon = 'favicon.ico' 187 | 188 | # Add any paths that contain custom static files (such as style sheets) here, 189 | # relative to this directory. They are copied after the builtin static files, 190 | # so a file named "default.css" will overwrite the builtin "default.css". 191 | html_static_path = ['_static'] 192 | 193 | # Add any extra paths that contain custom files (such as robots.txt or 194 | # .htaccess) here, relative to this directory. These files are copied 195 | # directly to the root of the documentation. 196 | #html_extra_path = [] 197 | 198 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 199 | # using the given strftime format. 200 | #html_last_updated_fmt = '%b %d, %Y' 201 | 202 | # If true, SmartyPants will be used to convert quotes and dashes to 203 | # typographically correct entities. 204 | #html_use_smartypants = True 205 | 206 | # Custom sidebar templates, maps document names to template names. 207 | # html_sidebars = {'**': ['localtoc.html', 'sourcelink.html']} 208 | 209 | # Additional templates that should be rendered to pages, maps page names to 210 | # template names. 211 | #html_additional_pages = {} 212 | 213 | # If false, no module index is generated. 214 | #html_domain_indices = True 215 | 216 | # If false, no index is generated. 217 | #html_use_index = True 218 | 219 | # If true, the index is split into individual pages for each letter. 220 | #html_split_index = False 221 | 222 | # If true, links to the reST sources are added to the pages. 223 | html_show_sourcelink = False 224 | 225 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 226 | #html_show_sphinx = True 227 | 228 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 229 | #html_show_copyright = True 230 | 231 | # If true, an OpenSearch description file will be output, and all pages will 232 | # contain a tag referring to it. The value of this option must be the 233 | # base URL from which the finished HTML is served. 234 | #html_use_opensearch = '' 235 | 236 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 237 | #html_file_suffix = None 238 | 239 | # Output file base name for HTML help builder. 240 | htmlhelp_basename = 'EPWavedoc' 241 | 242 | 243 | # -- Options for LaTeX output --------------------------------------------- 244 | 245 | latex_elements = { 246 | # The paper size ('letterpaper' or 'a4paper'). 247 | #'papersize': 'letterpaper', 248 | 249 | # The font size ('10pt', '11pt' or '12pt'). 250 | #'pointsize': '10pt', 251 | 252 | # Additional stuff for the LaTeX preamble. 253 | #'preamble': '', 254 | } 255 | 256 | # Grouping the document tree into LaTeX files. List of tuples 257 | # (source start file, target name, title, 258 | # author, documentclass [howto/manual]). 259 | latex_documents = [ 260 | ('index', 'EPWave.tex', u'EPWave Documentation', 261 | u'Doulos', 'manual'), 262 | ] 263 | 264 | # The name of an image file (relative to this directory) to place at the top of 265 | # the title page. 266 | #latex_logo = None 267 | 268 | # For "manual" documents, if this is true, then toplevel headings are parts, 269 | # not chapters. 270 | #latex_use_parts = False 271 | 272 | # If true, show page references after internal links. 273 | #latex_show_pagerefs = False 274 | 275 | # If true, show URL addresses after external links. 276 | #latex_show_urls = False 277 | 278 | # Documents to append as an appendix to all manuals. 279 | #latex_appendices = [] 280 | 281 | # If false, no module index is generated. 282 | #latex_domain_indices = True 283 | 284 | 285 | # -- Options for manual page output --------------------------------------- 286 | 287 | # One entry per manual page. List of tuples 288 | # (source start file, name, description, authors, manual section). 289 | man_pages = [ 290 | ('index', 'epwave', u'EPWave Documentation', 291 | [u'Doulos'], 1) 292 | ] 293 | 294 | # If true, show URL addresses after external links. 295 | #man_show_urls = False 296 | 297 | 298 | # -- Options for Texinfo output ------------------------------------------- 299 | 300 | # Grouping the document tree into Texinfo files. List of tuples 301 | # (source start file, target name, title, author, 302 | # dir menu entry, description, category) 303 | texinfo_documents = [ 304 | ('index', 'EPWave', u'EPWave Documentation', 305 | u'Doulos', 'EPWave', 'One line description of project.', 306 | 'Miscellaneous'), 307 | ] 308 | 309 | # Documents to append as an appendix to all manuals. 310 | #texinfo_appendices = [] 311 | 312 | # If false, no module index is generated. 313 | #texinfo_domain_indices = True 314 | 315 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 316 | #texinfo_show_urls = 'footnote' 317 | 318 | # If true, do not generate a @detailmenu in the "Top" node's menu. 319 | #texinfo_no_detailmenu = False 320 | -------------------------------------------------------------------------------- /docs/faq.rst: -------------------------------------------------------------------------------- 1 | ### 2 | FAQ 3 | ### 4 | 5 | ************************************************************** 6 | Can I view the waves from my EDA Playground sim using EPWaves? 7 | ************************************************************** 8 | 9 | Yes, see :ref:`loading-waves-from-playground` 10 | 11 | ********************************* 12 | Which wave formats are supported? 13 | ********************************* 14 | 15 | \*.vcd wave format is currently supported. \*.fsdb support is available for private deployments. 16 | 17 | *********************************************** 18 | How do I get updates about new EPWave features? 19 | *********************************************** 20 | New features are frequently being added to EPWave and EDA Playground. Follow the updates on your favorite social media site: 21 | 22 | * `@EDAPlayground on Twitter `_ 23 | * `EDA Playground on Facebook `_ 24 | * `EDA Playground on Google+ `_ 25 | 26 | ************************************** 27 | What are the limits for loading waves? 28 | ************************************** 29 | 30 | The \*.vcd file size limit is 20MB. Larger limits are available for private deployments. 31 | 32 | If the wave dump contains more than 2000 signals, then only the first 2000 signals will be loaded. 33 | You may use the *Signal Filter* to load the other signals. See :ref:`loading-waves-from-file-url` 34 | 35 | ********************************* 36 | Which web browsers are supported? 37 | ********************************* 38 | 39 | * Firefox 40 | * Chrome 41 | * Internet Explorer 9 or higher 42 | 43 | ************************************************************* 44 | How do I log in if I don't have a Google or Facebook account? 45 | ************************************************************* 46 | 47 | We are working on providing additional ways to sign into **EDA Playground**. Meanwhile, please create a new Google 48 | account at https://accounts.google.com/SignUp and use that to sign in. 49 | 50 | Note: If you're using EDA Playground on a private network, log in with the authentication credentials for your network. 51 | 52 | ******************************************** 53 | I have more questions. How do I get support? 54 | ******************************************** 55 | 56 | **EPWave** is actively being improved. If you need help or have suggestions, support is available on 57 | `EDA Playground forum `_ 58 | 59 | If you see a bug, however minor, please post on the forum or 60 | file a new issue at https://github.com/edaplayground/epwave/issues (requires GitHub account) 61 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | #################### 2 | EPWave Documentation 3 | #################### 4 | | *EPWave* (EDA Playground Wave) is a free interactive browser-based wave viewer. 5 | | *EPWave* web application located at http://www.edaplayground.com/w 6 | 7 | .. raw:: html 8 | 9 | 10 | 11 | Table of Contents: 12 | ------------------ 13 | 14 | .. toctree:: 15 | :maxdepth: 3 16 | 17 | intro 18 | quick-start 19 | faq 20 | -------------------------------------------------------------------------------- /docs/intro.rst: -------------------------------------------------------------------------------- 1 | ############ 2 | Introduction 3 | ############ 4 | | *EPWave* web application located at http://www.edaplayground.com/w 5 | 6 | .. raw:: html 7 | 8 | 9 | 10 | ******** 11 | Overview 12 | ******** 13 | 14 | EPWave is a free interactive browser-based waveform viewer for design and verification engineers. The primary use cases are: 15 | 16 | * Run prototype/example code on EDA Playground and view wave results with EPWave. 17 | * Quickly view waves for simulations that ran in the cloud (private or public). 18 | 19 | * Example: EPWave plugs into existing browser-based regression systems. 20 | 21 | EPWave is part of the `EDA Playground `_ tool suite. 22 | 23 | ************* 24 | Example Waves 25 | ************* 26 | 27 | * `Trivial Example `_ 28 | * `OpenCores Example `_ 29 | 30 | *************************************** 31 | Support, Feature Requests and Bug Fixes 32 | *************************************** 33 | 34 | | Support available on `EDA Playground forum `_ 35 | | Or open a bug here: https://github.com/edaplayground/epwave/issues (requires GitHub account). 36 | 37 | ********************* 38 | News and Site Updates 39 | ********************* 40 | New features are frequently being added to EPWave and EDA Playground. Follow the updates on your favorite social media site: 41 | 42 | * `@EDAPlayground on Twitter `_ 43 | * `EDA Playground on Facebook `_ 44 | * `EDA Playground on Google+ `_ 45 | 46 | ******* 47 | Credits 48 | ******* 49 | 50 | **EPWave** was created by Doulos. 51 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | REM Command file for Sphinx documentation 4 | 5 | if "%SPHINXBUILD%" == "" ( 6 | set SPHINXBUILD=sphinx-build 7 | ) 8 | set BUILDDIR=_build 9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . 10 | set I18NSPHINXOPTS=%SPHINXOPTS% . 11 | if NOT "%PAPER%" == "" ( 12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 14 | ) 15 | 16 | if "%1" == "" goto help 17 | 18 | if "%1" == "help" ( 19 | :help 20 | echo.Please use `make ^` where ^ is one of 21 | echo. html to make standalone HTML files 22 | echo. dirhtml to make HTML files named index.html in directories 23 | echo. singlehtml to make a single large HTML file 24 | echo. pickle to make pickle files 25 | echo. json to make JSON files 26 | echo. htmlhelp to make HTML files and a HTML help project 27 | echo. qthelp to make HTML files and a qthelp project 28 | echo. devhelp to make HTML files and a Devhelp project 29 | echo. epub to make an epub 30 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 31 | echo. text to make text files 32 | echo. man to make manual pages 33 | echo. texinfo to make Texinfo files 34 | echo. gettext to make PO message catalogs 35 | echo. changes to make an overview over all changed/added/deprecated items 36 | echo. xml to make Docutils-native XML files 37 | echo. pseudoxml to make pseudoxml-XML files for display purposes 38 | echo. linkcheck to check all external links for integrity 39 | echo. doctest to run all doctests embedded in the documentation if enabled 40 | goto end 41 | ) 42 | 43 | if "%1" == "clean" ( 44 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 45 | del /q /s %BUILDDIR%\* 46 | goto end 47 | ) 48 | 49 | 50 | %SPHINXBUILD% 2> nul 51 | if errorlevel 9009 ( 52 | echo. 53 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 54 | echo.installed, then set the SPHINXBUILD environment variable to point 55 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 56 | echo.may add the Sphinx directory to PATH. 57 | echo. 58 | echo.If you don't have Sphinx installed, grab it from 59 | echo.http://sphinx-doc.org/ 60 | exit /b 1 61 | ) 62 | 63 | if "%1" == "html" ( 64 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 65 | if errorlevel 1 exit /b 1 66 | echo. 67 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. 68 | goto end 69 | ) 70 | 71 | if "%1" == "dirhtml" ( 72 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 73 | if errorlevel 1 exit /b 1 74 | echo. 75 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 76 | goto end 77 | ) 78 | 79 | if "%1" == "singlehtml" ( 80 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 81 | if errorlevel 1 exit /b 1 82 | echo. 83 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 84 | goto end 85 | ) 86 | 87 | if "%1" == "pickle" ( 88 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 89 | if errorlevel 1 exit /b 1 90 | echo. 91 | echo.Build finished; now you can process the pickle files. 92 | goto end 93 | ) 94 | 95 | if "%1" == "json" ( 96 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 97 | if errorlevel 1 exit /b 1 98 | echo. 99 | echo.Build finished; now you can process the JSON files. 100 | goto end 101 | ) 102 | 103 | if "%1" == "htmlhelp" ( 104 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 105 | if errorlevel 1 exit /b 1 106 | echo. 107 | echo.Build finished; now you can run HTML Help Workshop with the ^ 108 | .hhp project file in %BUILDDIR%/htmlhelp. 109 | goto end 110 | ) 111 | 112 | if "%1" == "qthelp" ( 113 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 114 | if errorlevel 1 exit /b 1 115 | echo. 116 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ 117 | .qhcp project file in %BUILDDIR%/qthelp, like this: 118 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\EDAPlayground.qhcp 119 | echo.To view the help file: 120 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\EDAPlayground.ghc 121 | goto end 122 | ) 123 | 124 | if "%1" == "devhelp" ( 125 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 126 | if errorlevel 1 exit /b 1 127 | echo. 128 | echo.Build finished. 129 | goto end 130 | ) 131 | 132 | if "%1" == "epub" ( 133 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 134 | if errorlevel 1 exit /b 1 135 | echo. 136 | echo.Build finished. The epub file is in %BUILDDIR%/epub. 137 | goto end 138 | ) 139 | 140 | if "%1" == "latex" ( 141 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 142 | if errorlevel 1 exit /b 1 143 | echo. 144 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 145 | goto end 146 | ) 147 | 148 | if "%1" == "latexpdf" ( 149 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 150 | cd %BUILDDIR%/latex 151 | make all-pdf 152 | cd %BUILDDIR%/.. 153 | echo. 154 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 155 | goto end 156 | ) 157 | 158 | if "%1" == "latexpdfja" ( 159 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 160 | cd %BUILDDIR%/latex 161 | make all-pdf-ja 162 | cd %BUILDDIR%/.. 163 | echo. 164 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 165 | goto end 166 | ) 167 | 168 | if "%1" == "text" ( 169 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 170 | if errorlevel 1 exit /b 1 171 | echo. 172 | echo.Build finished. The text files are in %BUILDDIR%/text. 173 | goto end 174 | ) 175 | 176 | if "%1" == "man" ( 177 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 178 | if errorlevel 1 exit /b 1 179 | echo. 180 | echo.Build finished. The manual pages are in %BUILDDIR%/man. 181 | goto end 182 | ) 183 | 184 | if "%1" == "texinfo" ( 185 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 186 | if errorlevel 1 exit /b 1 187 | echo. 188 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 189 | goto end 190 | ) 191 | 192 | if "%1" == "gettext" ( 193 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 194 | if errorlevel 1 exit /b 1 195 | echo. 196 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 197 | goto end 198 | ) 199 | 200 | if "%1" == "changes" ( 201 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 202 | if errorlevel 1 exit /b 1 203 | echo. 204 | echo.The overview file is in %BUILDDIR%/changes. 205 | goto end 206 | ) 207 | 208 | if "%1" == "linkcheck" ( 209 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 210 | if errorlevel 1 exit /b 1 211 | echo. 212 | echo.Link check complete; look for any errors in the above output ^ 213 | or in %BUILDDIR%/linkcheck/output.txt. 214 | goto end 215 | ) 216 | 217 | if "%1" == "doctest" ( 218 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 219 | if errorlevel 1 exit /b 1 220 | echo. 221 | echo.Testing of doctests in the sources finished, look at the ^ 222 | results in %BUILDDIR%/doctest/output.txt. 223 | goto end 224 | ) 225 | 226 | if "%1" == "xml" ( 227 | %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml 228 | if errorlevel 1 exit /b 1 229 | echo. 230 | echo.Build finished. The XML files are in %BUILDDIR%/xml. 231 | goto end 232 | ) 233 | 234 | if "%1" == "pseudoxml" ( 235 | %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml 236 | if errorlevel 1 exit /b 1 237 | echo. 238 | echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. 239 | goto end 240 | ) 241 | 242 | :end 243 | -------------------------------------------------------------------------------- /docs/quick-start.rst: -------------------------------------------------------------------------------- 1 | ########### 2 | Quick Start 3 | ########### 4 | 5 | You must be logged in to load or save waves. 6 | 7 | .. _loading-waves-from-playground: 8 | 9 | ********************************* 10 | Loading Waves from EDA Playground 11 | ********************************* 12 | 13 | You can run a simulation on EDA Playground and load the resulting waves in EPWave. 14 | 15 | * Go to your code on EDA Playground. For example: `RAM Design and Test `_ 16 | * Make sure your code contains appropriate function calls to create a \*.vcd file. For example: 17 | 18 | .. code-block:: verilog 19 | 20 | initial begin 21 | $dumpfile("dump.vcd"); 22 | $dumpvars(1); 23 | end 24 | 25 | * Select a simulator and check the **Open EPWave after run** checkbox. (Not all simulators may have this run option.) 26 | 27 | .. image:: _static/openEpwaveCheckbox.png 28 | 29 | * Click **Run**. After the run completes, the resulting waves will load in a new EPWave window. (Pop-ups must be enabled.) 30 | 31 | .. _loading-waves-from-file-url: 32 | 33 | ****************************** 34 | Loading Waves from File or URL 35 | ****************************** 36 | 37 | * On `EPWave Homepage `_, specify the wave dump file to load. There are 2 sources for loading waves. 38 | 39 | #. Specify the URL pointing to the waves accessible over the web, such as a file in a public Dropbox folder. 40 | #. Upload the wave dump from your own computer. 41 | 42 | * After specifying the wave dump file, you can click the **Load** button to load the waves. 43 | 44 | * If your wave dump contains 2000 signals or larger, you may specify a *Signal Filter* so that fewer than 2000 signals are loaded. 45 | If *Signal Filter* is not specified, then only the first 2000 signals will be loaded. 46 | Click on the **+** on the top left to open the *Signal Filter*. For \*.vcd files, the filter accepts regular expressions. 47 | 48 | .. image:: _static/signal_filter.png 49 | 50 | After specifying the *Signal Filter*, click the **Load** button to load the waves. 51 | 52 | * (Optional) You may specify the *From* and/or *To* times to limit the time range of the loaded wave. 53 | If your wave dump contains a lot of data, then the ending *To* time will automatically be limited. 54 | 55 | .. image:: _static/from_to.png 56 | 57 | *************** 58 | Viewing Signals 59 | *************** 60 | 61 | After loading the waves, you can display signals by using the **Get Signals** button. 62 | 63 | .. image:: _static/get_signals.png 64 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx-bootstrap-theme==0.3.5 2 | --------------------------------------------------------------------------------