Skip to content

Commit

Permalink
Implement pip install magia-hdl[full]
Browse files Browse the repository at this point in the history
  • Loading branch information
khwong-c committed Jan 18, 2024
1 parent 7813861 commit 7271a03
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Please refer to the [Magia Roadmap](docs/roadmap.md).

```bash
pip install magia-hdl

# Install with full dependencies if advanced features are required

pip install magia-hdl[full]
```

## Examples
Expand Down
11 changes: 10 additions & 1 deletion docs/external_module.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,16 @@ Common Use-cases are importing IP core such as:

## Prerequisite

We need to install [hdlConvertor](https://github.com/Nic30/hdlConvertor) for this feature.
This feature requires extra packages to be installed.
Install with full features by running:

```bash
pip install magia-hdl[full]
```

Or install the following packages manually:

- [hdlConvertor](https://github.com/Nic30/hdlConvertor)

Run the following command to install hdlConvertor, if you are running on Linux X86_64:

Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,12 @@ keywords = [
"Code Generation", "FPGA", "ASIC", "EDA", "RTL Design"
]

[tool.poetry.extras]
full = ["hdlConvertor-binary"]

[tool.poetry.dependencies]
python = "^3.9"
hdlConvertor-binary = { version = "~2.3", optional=true }

[tool.poetry.group.dev.dependencies]
cocotb = "*"
Expand Down

0 comments on commit 7271a03

Please # to comment.