# pythondata-cpu-microwatt

Non-Python  files needed for the cpu microwatt packaged
into a Python module so they can be used with Python libraries and tools.

This is useful for usage with tools like
[LiteX](https://github.com/enjoy-digital/litex.git).

The data files can be found under the Python module `pythondata_cpu_microwatt`. The
`pythondata_cpu_microwatt.data_location` value can be used to find the files on the file
system.

Example of getting the data file directly;
```python
import pythondata_cpu_microwatt

my_data_file = "abc.txt"

with open(os.path.join(pythondata_cpu_microwatt.data_location, my_data_file)) as f:
    print(f.read())
```

Example of getting the data file using `litex.data.find` API;
```python
from pythondata_cpu_microwatt import data_file

my_data_file = "abc.txt"

with open(data_file(my_data_file)) as f:
    print(f.read())
```


The data files come from https://github.com/antonblanchard/microwatt
and are imported using `git subtrees` to the directory
[pythondata_cpu_microwatt/vhdl](pythondata_cpu_microwatt/vhdl).



# Installing

## Directly from git repository

### Manually

You can install the package manually, however this is **not** recommended.

```
git clone https://github.com/litex-hub/pythondata-cpu-microwatt.git
cd pythondata-cpu-microwatt
sudo python setup.py install
```

### Using [pip](https://pip.pypa.io/) with git repository

You can use [pip](https://pip.pypa.io/) to install the data package directly
from github using;

```
pip install --user git+https://github.com/litex-hub/pythondata-cpu-microwatt.git
```

If you want to install for the whole system rather than just the current user,
you need to remove the `--user` argument and run as sudo like so;

```
sudo pip install git+https://github.com/litex-hub/pythondata-cpu-microwatt.git
```

You can install a specific revision of the repository using;
```
pip install --user git+https://github.com/litex-hub/pythondata-cpu-microwatt.git@<tag>
pip install --user git+https://github.com/litex-hub/pythondata-cpu-microwatt.git@<branch>
pip install --user git+https://github.com/litex-hub/pythondata-cpu-microwatt.git@<hash>
```

### With `requirements.txt` file

Add to your Python `requirements.txt` file using;
```
-e git+https://github.com/litex-hub/pythondata-cpu-microwatt.git
```

To use a specific revision of the repository, use the following;
```
-e https://github.com/litex-hub/pythondata-cpu-microwatt.git@<hash>
```

## Via [PyPi](https://pypi.org/project/pythondata-cpu-microwatt/)

### Using [pip](https://pip.pypa.io/)

```
pip install --user pythondata-cpu-microwatt
```

### With `requirements.txt` file

Add to your Python `requirements.txt` file using;
```
pythondata-cpu-microwatt
```
