47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
Before installing, make sure to upgrade your `pip` to the latest version:
|
|
|
|
```bash
|
|
pip install --upgrade pip
|
|
```
|
|
|
|
## Latest Release (Recommended)
|
|
The latest release of Manta can be installed from PyPI with:
|
|
|
|
```bash
|
|
pip install --upgrade manta-fpga
|
|
```
|
|
|
|
## Development Snapshot
|
|
The latest development snapshot of Manta can be installed with:
|
|
|
|
```bash
|
|
pip install --upgrade git+https://github.com/fischermoseley/manta.git
|
|
```
|
|
|
|
It's recommended to install Manta into a virtual environment, instead of your system Python. Among the many other benefits virtual environments offer, this will conveniently add the `manta` executable to your PATH. This allows you to invoke the tool with `manta`, rather than the more verbose `python3 -m manta`.
|
|
|
|
## Editable Development Install
|
|
If you're working on the source, you might want an editable installation with some extra dependencies used for development:
|
|
|
|
```bash
|
|
git clone https://github.com/fischermoseley/manta.git
|
|
cd manta
|
|
uv sync
|
|
source .venv/bin/activate
|
|
pre-commit install
|
|
```
|
|
|
|
The build system also uses the open-source `xc3sprog` and `iceprog` tools for programming Xilinx and ice40 devices, respectively. If you'd like to run these tests locally, you may need to install these tools and have them available on your `PATH`.
|
|
|
|
If you're on Linux, you may also need to add a new udev rule to give non-superuser accounts access to any connected FTDI devices. This can be done by making a new file at `/etc/udev/rules.d/99-ftdi-devices.rules`, which contains:
|
|
|
|
```
|
|
ACTION=="add", ATTR{idVendor}=="0403", ATTR{idProduct}=="6010", MODE:="666"
|
|
```
|
|
|
|
Be sure to reload your udev rules after saving the file. On most distributions, this is accomplished with:
|
|
|
|
```bash
|
|
udevadm control --reload-rules && udevadm trigger
|
|
```
|