SimplHDL 0.0.1__tar.gz → 0.0.4__tar.gz

SimplHDL-0.0.4/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

SimplHDL-0.0.4/.gitignore

@@ -0,0 +1,95 @@
+# SimplHDL build dir
+_build
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# VSCode
+.vscode

SimplHDL-0.0.4/.readthedocs.yaml

@@ -0,0 +1,28 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

SimplHDL-0.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SimplHDL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

SimplHDL-0.0.4/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.1
+Name: SimplHDL
+Version: 0.0.4
+Summary: A framework for simulating and implementing HDL designs
+Author-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
+Maintainer-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 SimplHDL
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/SimplHDL
+Project-URL: Documentation, https://simplhdl.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/SimplHDL/simplhdl.git
+Project-URL: Issues, https://github.com/SimplHDL/simplhdl/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: importlib-resources; python_version < "3.9"
+Requires-Dist: pySVModel==0.3.5
+Requires-Dist: pyEDAA.ProjectModel==0.4.3
+Requires-Dist: pyyaml
+Requires-Dist: types-PyYAML
+Requires-Dist: argcomplete
+Requires-Dist: jinja2
+Requires-Dist: GitPython
+
+## Introduction
+
+SimplHDL is a plugin-based command-line application for simplifying FPGA and
+ASIC development regardless of EDA tools and flows.
+
+The goal is to embrase structured and reusable designs by creating a generic
+project model that can be used in any hdl development flow regardless of
+project structure and EDA tool requirements.
+
+The plugin based architecture allows for SimplHDL to be migrated into any
+existing project, replacing ad-hoc simulation and implmentation scripts while
+providing a intuitive command-line interface for HDL design and verification
+engineers.
+
+I wide vararity of languges, standards and tools are supported.
+
+### HDL languages
+
+* Verilog / System Verilog
+* VHDL
+* Chisel
+* SystemRDL
+* IPXact
+* Vivado IP containters (.xci, .xcix)
+* Quartus IP containers (.ip)
+
+### Methodologies
+
+* UVM
+* OSVMM
+* UVVM
+* Cocotb
+* pyuvm
+
+### EDA Tools
+
+* Vivado
+* Quartus
+* Modelsim
+* Questasim
+* Xsim
+* Vcs
+* Riviera Pro
+* Xcelium (coming)
+* Verilator (coming)
+* Icarus (coming)
+* GHDL (coming)
+
+## Getting Started
+
+SimplHDL currently works on Linux and Windows WSL. It is written in Python and can
+be installed with *pip*. To run SimplHDL Python 3.8 or later is required. The
+tools for the flows you wish to run also need to be installed and set up
+correctly in the shell environment. SimplHDL can be installed on your system's
+Python installation, but it is highly recommended to install and run SimplHDL
+in a Python virtual environment or a Conda environment.
+
+## Example
+
+To quickly try out SimplHDL follow these steps. In this example, we will use
+Vivado and QuestaSim. The prerequisites are that SimplHDL install installed and
+Vivado and QuestaSim are correctly set up in your shell environment.
+
+1. Clone Git repository from GitHub
+
+```console
+git clone https://github.com/SimplHDL/simplhdl.git
+```
+
+2. install SimplHDL from source
+
+```console
+pip install ./simplhdl
+```
+
+3. Run simulation
+
+```console
+cd simplhdl/examples/hdl/alu/sim
+simpl questasim
+```
+
+4. Run simulation interactively in Gui.
+
+```console
+cd simplhdl/examples/hdl/alu/sim
+simpl questasim --gui
+```
+
+5. Run implementation
+
+```console
+cd ../syn
+simpl vivado
+```
+
+6. Run implementation interactively in Gui.
+
+```console
+simpl vivado --gui
+```
+
+In this example, the project specification is written in Yaml. This format is
+only meant as a demonstration. To integrate SimplHDL into your project, you have
+to write a parser plugin for your specific project specification format.
+See the documentation and plugin examples for more information.
+
+## Links
+
+* Homepage:
+* Source: <https://github.com/SimplHDL/simplhdl>
+* Tracker: <https://github.com/SimplHDL/simplhdl/issues>

SimplHDL-0.0.4/README.md

@@ -0,0 +1,112 @@
+## Introduction
+
+SimplHDL is a plugin-based command-line application for simplifying FPGA and
+ASIC development regardless of EDA tools and flows.
+
+The goal is to embrase structured and reusable designs by creating a generic
+project model that can be used in any hdl development flow regardless of
+project structure and EDA tool requirements.
+
+The plugin based architecture allows for SimplHDL to be migrated into any
+existing project, replacing ad-hoc simulation and implmentation scripts while
+providing a intuitive command-line interface for HDL design and verification
+engineers.
+
+I wide vararity of languges, standards and tools are supported.
+
+### HDL languages
+
+* Verilog / System Verilog
+* VHDL
+* Chisel
+* SystemRDL
+* IPXact
+* Vivado IP containters (.xci, .xcix)
+* Quartus IP containers (.ip)
+
+### Methodologies
+
+* UVM
+* OSVMM
+* UVVM
+* Cocotb
+* pyuvm
+
+### EDA Tools
+
+* Vivado
+* Quartus
+* Modelsim
+* Questasim
+* Xsim
+* Vcs
+* Riviera Pro
+* Xcelium (coming)
+* Verilator (coming)
+* Icarus (coming)
+* GHDL (coming)
+
+## Getting Started
+
+SimplHDL currently works on Linux and Windows WSL. It is written in Python and can
+be installed with *pip*. To run SimplHDL Python 3.8 or later is required. The
+tools for the flows you wish to run also need to be installed and set up
+correctly in the shell environment. SimplHDL can be installed on your system's
+Python installation, but it is highly recommended to install and run SimplHDL
+in a Python virtual environment or a Conda environment.
+
+## Example
+
+To quickly try out SimplHDL follow these steps. In this example, we will use
+Vivado and QuestaSim. The prerequisites are that SimplHDL install installed and
+Vivado and QuestaSim are correctly set up in your shell environment.
+
+1. Clone Git repository from GitHub
+
+```console
+git clone https://github.com/SimplHDL/simplhdl.git
+```
+
+2. install SimplHDL from source
+
+```console
+pip install ./simplhdl
+```
+
+3. Run simulation
+
+```console
+cd simplhdl/examples/hdl/alu/sim
+simpl questasim
+```
+
+4. Run simulation interactively in Gui.
+
+```console
+cd simplhdl/examples/hdl/alu/sim
+simpl questasim --gui
+```
+
+5. Run implementation
+
+```console
+cd ../syn
+simpl vivado
+```
+
+6. Run implementation interactively in Gui.
+
+```console
+simpl vivado --gui
+```
+
+In this example, the project specification is written in Yaml. This format is
+only meant as a demonstration. To integrate SimplHDL into your project, you have
+to write a parser plugin for your specific project specification format.
+See the documentation and plugin examples for more information.
+
+## Links
+
+* Homepage:
+* Source: <https://github.com/SimplHDL/simplhdl>
+* Tracker: <https://github.com/SimplHDL/simplhdl/issues>

SimplHDL-0.0.4/docs/conf.py

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import sys
+import time
+from os import environ
+from os.path import abspath, join
+from pathlib import Path
+from sphinx_pyproject import SphinxConfig
+from simplhdl import __version__
+
+sys.path.insert(0, abspath('.'))
+sys.path.insert(0, abspath('..'))
+sys.path.insert(0, abspath('../src/simplhdl'))
+
+config = SphinxConfig(
+    "../pyproject.toml",
+    globalns=globals(),
+    config_overrides={'version': __version__})
+
+
+project = name
+copyright = f"2016-{time.strftime('%Y')}, {author}"
+release = version
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+# templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']
+html_logo = join(abspath('.'), html_static_path[0], 'simplhdl_light_1.png')
+
+html_theme_options = {
+    "source_repository": "https://github.com/SimplHDL/simplhdl",
+    "source_branch": environ.get("GITHUB_REF_NAME", "main"),
+    "source_directory": "",
+    "sidebar_hide_name": True,
+    "footer_icons": [
+        {
+            "name": "Gitter hdl/community",
+            "url": "https://gitter.im/hdl/community",
+            "html": "",
+            "class": "fa-solid fa-brands fa-gitter",
+        },
+        {
+            "name": "GitHub https://github.com/SimplHDL/simplhdl",
+            "url": "https://github.com/SimplHDL/simplhdl",
+            "html": "",
+            "class": "fa-solid fa-brands fa-github",
+        },
+    ],
+}