Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
14 of 139 committers (10.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.1%) to scientific vocabulary
Keywords
Repository
Scala based HDL
Basic Info
Statistics
- Stars: 1,842
- Watchers: 81
- Forks: 358
- Open Issues: 181
- Releases: 30
Topics
Metadata Files
README.md
About SpinalHDL
SpinalHDL is:
- A language to describe digital hardware
- Compatible with EDA tools, as it generates VHDL/Verilog files
- Much more powerful than VHDL, Verilog, and SystemVerilog in its syntax and features
- Much less verbose than VHDL, Verilog, and SystemVerilog
- Not an HLS, nor based on the event-driven paradigm
- Only generates what you asked it in a one-to-one way (no black-magic, no black box)
- Not introducing area/performance overheads in your design (versus a hand-written VHDL/Verilog design)
- Based on the RTL description paradigm, but can go much further
- Allowing you to use Object-Oriented Programming and Functional Programming to elaborate your hardware and verify it
- Free and can be used in the industry without any license
Links
- Documentation
https://spinalhdl.github.io/SpinalDoc-RTD/ - Chinese documentation
https://spinalhdl.github.io/SpinalDoc-RTD/zh_CN/ - Chinese documentation (v1.7.2 from thuCGRA)
https://thucgra.github.io/SpinalHDLChineseDoc/ - API reference
https://spinalhdl.github.io/SpinalHDL/dev/spinal/index.html - Presentation of the language
https://github.com/SpinalHDL/SpinalDoc/blob/master/presentation/en/presentation.pdf - SBT base project
https://github.com/SpinalHDL/SpinalTemplateSbt - Gradle base project
https://github.com/SpinalHDL/SpinalTemplateGradle - Jupyter bootcamp
https://github.com/SpinalHDL/Spinal-bootcamp - Workshop
https://github.com/SpinalHDL/SpinalWorkshop - Google group
https://groups.google.com/forum/#!forum/spinalhdl-hardware-description-language - Donation channel
https://opencollective.com/spinalhdl
Get it
SpinalHDL is simply a set of Scala libraries. Include them into your project and you're good to go! If you're unsure about what to do, simply clone one of our example projects (see links above).
SBT (Scala build tool)
```scala scalaVersion := "2.11.12"
libraryDependencies ++= Seq( "com.github.spinalhdl" % "spinalhdl-core2.11" % "latest.release", "com.github.spinalhdl" % "spinalhdl-lib2.11" % "latest.release", compilerPlugin("com.github.spinalhdl" % "spinalhdl-idsl-plugin_2.11" % "latest.release") ) ```
You can force SBT to pick a specific SpinalHDL version by replacing latest.release with a specific version.
See the SpinalHDL SBT Template project's build.sbt file for a full SBT example.
Gradle
```kotlin repositories { mavenCentral() }
dependencies { compile group: 'com.github.spinalhdl', name: 'spinalhdl-core2.11', version: '1.6.4' compile group: 'com.github.spinalhdl', name: 'spinalhdl-lib2.11', version: '1.6.4' } ```
Mill(Build Tool)
```scala import mill._ import mill.scalalib._
object MySpinalModule extends ScalaModule { def scalaVersion = "2.11.12"
def ivyDeps = Agg( ivy"com.github.spinalhdl::spinalhdl-core:1.6.4", ivy"com.github.spinalhdl::spinalhdl-lib:1.6.4", )
def scalacPluginIvyDeps = Agg(ivy"com.github.spinalhdl::spinalhdl-idsl-plugin:1.6.4") } ```
JAR
https://oss.sonatype.org/content/groups/public/com/github/spinalhdl/spinalhdl-core_2.11/
https://oss.sonatype.org/content/groups/public/com/github/spinalhdl/spinalhdl-lib_2.11/
The files are available on Maven as well.
Change logs
https://github.com/SpinalHDL/SpinalHDL/tags
License
The SpinalHDL core is using the LGPL3 license while SpinalHDL lib and others are using the MIT license. That's for the formalities. But there are some practical statements implied by those licenses:
Your freedoms are:
- You can use SpinalHDL core and lib in your closed/commercial projects.
- The generated RTL is yours (.vhd/.v files)
- Your hardware description is yours (.scala files)
Your obligations (and my wish) are:
- If you modify the SpinalHDL core (the compiler itself), please, share your improvements.
Also, SpinalHDL is provided "as is", without warranty of any kind.
Owner
- Name: SpinalHDL
- Login: SpinalHDL
- Kind: organization
- Email: spinalhdl@gmail.com
- Repositories: 20
- Profile: https://github.com/SpinalHDL
A high level hardware description language
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: SpinalHDL
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Charles
family-names: Papon
email: charles.papon.90@gmail.com
- given-names: Yindong
family-names: Xiao
orcid: "https://orcid.org/0000-0003-1214-6077"
repository-code: 'https://github.com/SpinalHDL/SpinalHDL'
license: LGPL-3.0
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Dolu1990 | c****0@g****m | 3,907 |
| Yindong | x****r@u****n | 541 |
| Jijing-mac14 | g****v@1****m | 306 |
| Aidan Klein | a****n@s****e | 239 |
| Morard Dany | d****d@h****m | 200 |
| Luca Cristaldi | w****i@g****m | 67 |
| Côme ALLART | n****4@n****m | 60 |
| Zhengpeng Liao | w****p@o****m | 56 |
| LiYaohong | 8****0@q****m | 52 |
| wangzilu | y****e@1****m | 49 |
| Andrea Bellandi | a****i@d****e | 49 |
| Andreas Wallner | A****r@i****t | 48 |
| Pengcheng Xu | p****u@e****h | 40 |
| Matthias Wächter | m****s@w****t | 39 |
| piegames | g****t@p****e | 35 |
| Snoopy87 | d****r@h****m | 33 |
| pluveto | z****g@p****e | 29 |
| Douglas Klein | d****a@g****m | 26 |
| Anton Schulte | a****e@h****e | 26 |
| Jiajie Chen | c@j****e | 25 |
| Duang | 1****2@q****m | 25 |
| Sebastien Van Cauwenberghe | s****u@g****m | 24 |
| Justin Berger | j****r@g****m | 24 |
| NikLeberg | n****b@g****m | 24 |
| facebreeze | s****s@g****m | 22 |
| c-thaler | b****m@g****m | 21 |
| Francisco Ayala Le Brun | f****n@g****m | 19 |
| Matthias Wächter | m****r@t****m | 19 |
| ZhaokunHu | 3****7@q****m | 18 |
| Alexis Marquet | a****s@a****m | 17 |
| and 109 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 254
- Total pull requests: 486
- Average time to close issues: about 2 months
- Average time to close pull requests: 17 days
- Total issue authors: 118
- Total pull request authors: 71
- Average comments per issue: 2.67
- Average comments per pull request: 2.54
- Merged pull requests: 360
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 88
- Pull requests: 230
- Average time to close issues: 7 days
- Average time to close pull requests: 7 days
- Issue authors: 49
- Pull request authors: 41
- Average comments per issue: 1.33
- Average comments per pull request: 1.97
- Merged pull requests: 167
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- KireinaHoro (18)
- Readon (17)
- facebreeze (9)
- louiecaulfield (7)
- NikLeberg (6)
- thajohns (6)
- oletf (6)
- developfpga (5)
- buloruabutata (5)
- dreamflyings (5)
- Mido-sun (5)
- Dolu1990 (5)
- zyn810039594 (4)
- dzjdegithub (4)
- chenbo-again (3)
Pull Request Authors
- Readon (72)
- KireinaHoro (37)
- jijingg (37)
- facebreeze (29)
- Dolu1990 (27)
- yportne13 (20)
- andreasWallner (20)
- jdavidberger (18)
- g0t00 (16)
- pluveto (16)
- fayalalebrun (15)
- thajohns (14)
- mrberman87 (12)
- mrcmry (10)
- JunyiLiu1994 (8)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 23
- Total downloads: unknown
-
Total dependent packages: 28
(may contain duplicates) -
Total dependent repositories: 5
(may contain duplicates) - Total versions: 1,089
proxy.golang.org: github.com/SpinalHDL/SpinalHDL
- Documentation: https://pkg.go.dev/github.com/SpinalHDL/SpinalHDL#section-documentation
- License: other
-
Latest release: v1.12.3
published 6 months ago
Rankings
proxy.golang.org: github.com/spinalhdl/spinalhdl
- Documentation: https://pkg.go.dev/github.com/spinalhdl/spinalhdl#section-documentation
- License: other
-
Latest release: v1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-core_2.11
SpinalHDL-core
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-core_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-sim_2.11
SpinalHDL-sim
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-sim_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-lib_2.11
SpinalHDL-lib
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-lib_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-sim_2.12
SpinalHDL-sim
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-sim_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-sim_2.13
SpinalHDL-sim
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-sim_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-core_2.12
SpinalHDL-core
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-core_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-core_2.13
SpinalHDL-core
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-core_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-lib_2.12
SpinalHDL-lib
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-lib_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-payload_2.12
SpinalHDL-idsl-payload
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-payload_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-plugin_2.11
SpinalHDL-idsl-plugin
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-plugin_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-payload_2.11
SpinalHDL-idsl-payload
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-payload_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-payload_2.13
SpinalHDL-idsl-payload
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-payload_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-plugin_2.13
SpinalHDL-idsl-plugin
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-plugin_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-lib_2.13
SpinalHDL-lib
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-lib_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-idsl-plugin_2.12
SpinalHDL-idsl-plugin
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-idsl-plugin_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-debugger_2.11
SpinalHDL Debugger
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-debugger_2.11/
- License: LGPL3
-
Latest release: 0.1.4
published almost 11 years ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-all_2.11
SpinalHDL all
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-all_2.11/
- License: LGPL3
-
Latest release: 0.1.1
published almost 11 years ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-test_2.11
SpinalHDL Test
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-test_2.11/
- License: LGPL3
-
Latest release: 0.1.1
published almost 11 years ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-tester_2.11
SpinalHDL-tester
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-tester_2.11/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-tester_2.12
SpinalHDL-tester
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-tester_2.12/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
repo1.maven.org: com.github.spinalhdl:spinalhdl-tester_2.13
SpinalHDL-tester
- Homepage: github.com/SpinalHDL/SpinalHDL
- Documentation: https://appdoc.app/artifact/com.github.spinalhdl/spinalhdl-tester_2.13/
- License: LGPL3
-
Latest release: 1.12.3
published 6 months ago
Rankings
Dependencies
- ./.github/actions * composite
- JamesIves/github-pages-deploy-action v4 composite
- actions/checkout v2 composite
- actions/cache/restore v3 composite
- actions/cache v3 composite
- actions/setup-java v3 composite
- actions/cache v3 composite
- actions/checkout v2 composite
- docker/build-push-action v4 composite
- docker/login-action v1 composite
- docker/metadata-action v4 composite
- ./.github/actions/get-compiled * composite
- actions/cache/save v3 composite
- actions/checkout v3 composite
- base latest build
- ghcr.io/spinalhdl/docker master build
- ./.github/actions/sbt * composite
- actions/checkout v3 composite