Skip to content

Commit

Permalink
Move riscv-tools.yaml to top-level | Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abejgonzalez committed Aug 4, 2023
1 parent 5f88e9e commit c11f4c0
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
run: |
cd ${{ env.REMOTE_WORK_DIR }}
eval "$(conda shell.bash hook)"
conda-lock --conda $(which conda) -f ./conda-reqs.yaml -f ./.github/riscv-tools.yaml -p linux-64
conda-lock --conda $(which conda) -f ./conda-reqs.yaml -f ./riscv-tools.yaml -p linux-64
conda-lock install --conda $(which conda) -p $PWD/.conda-env
- name: Install Spike
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/weekly-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
run: |
cd ${{ env.REMOTE_WORK_DIR }}
eval "$(conda shell.bash hook)"
conda-lock --conda $(which conda) -f ./conda-reqs.yaml -f ./.github/riscv-tools.yaml -p linux-64
conda-lock --conda $(which conda) -f ./conda-reqs.yaml -f ./riscv-tools.yaml -p linux-64
conda-lock install --conda $(which conda) -p $PWD/.conda-env
- name: Initialize all submodules
run: |
Expand Down
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,27 @@ FireMarshal uses the [Conda](https://docs.conda.io/en/latest/) package manager t
This allows users to create an "environment" that holds system dependencies like ``make``, ``git``, etc.
Please install Conda using the Chipyard documentation [here](https://chipyard.readthedocs.io/en/main/Chipyard-Basics/Initial-Repo-Setup.html#default-requirements-installation).

Next you can run the following command to create a FireMarshal environment called ``firemarshal``.

Next you can run the following command to create a FireMarshal environment called ``firemarshal`` with a RISC-V compatible toolchain:

```bash
conda env create -f ./conda-reqs.yaml -n firemarshal
conda-lock --conda $(which conda) -f ./conda-reqs.yaml -f ./riscv-tools.yaml -p linux-64
conda-lock install --conda $(which conda) -n firemarshal
```

To enter this environment, you then run the ``activate`` command.
**Note that this command should be run whenever you want to use FireMarshal so that packages can be properly be added to your ``PATH``**.

```bash
conda activate firemarshal # or whatever name you gave during environment creation
```

In addition to standard packages added in the conda environment, you will need a RISC-V compatible toolchain and the RISC-V ISA simulator (Spike).
A RISC-V compatible toolchain can be obtained by the following:

```bash
conda install -n firemarshal -c ucb-bar riscv-tools
conda activate firemarshal # or whatever name/prefix you gave during environment creation
```

In addition to standard packages added in the conda environment, you will need the RISC-V ISA simulator (Spike).
To install Spike, please refer to https://github.com/riscv-software-src/riscv-isa-sim.

Finally, if you are running as a user on a machine without ``sudo`` access it is required for you to install ``guestmount`` for disk manipulation.
You can install this through your default package manager (for ex. ``apt`` or ``yum``).
You can also follow along with the ``guestmount`` [installation instructions found in the FireSim project](https://docs.fires.im/en/stable/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/RHS-Research-Nitefury-II.html?highlight=guestmount#install-guestmount).

## Basic Usage

Expand Down
File renamed without changes.

0 comments on commit c11f4c0

Please sign in to comment.