Skip to content

Commit

Permalink
README: Improve pyenv error handling (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert Muchsel authored Dec 17, 2021
1 parent 84c5f50 commit 8c7ac01
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MAX78000 Model Training and Synthesis

_December 9, 2021_
_December 14, 2021_

The Maxim Integrated AI project is comprised of five repositories:

Expand Down Expand Up @@ -204,10 +204,13 @@ First, check the default Python version:
```shell
$ python --version
Python 2.7.18
# wrong version, pyenv required
```

This particular version will not function correctly with the MAX7800X tools. If the result is Python **3.8**.x, skip ahead to [git Environment](#git Environment). For any other version (for example, 2.7, 3.7, 3.9, 3.10), continue here.

*Note: For the purposes of the MAX7800X tools, “python3” is not a substitute for “python”. Please install pyenv when “python” does not return version 3.8.x, <u>even if</u> “python3” is available.*

##### pyenv

It is not necessary to install Python 3.8 system-wide, or to rely on the system-provided Python. To manage Python versions, instead use `pyenv` (https://github.com/pyenv/pyenv).
Expand Down Expand Up @@ -332,7 +335,10 @@ Then continue with the following:
$ python -m venv venv --prompt ai8x-training
```

If this command returns an error message similar to *“The virtual environment was not created successfully because ensurepip is not available,”* please install and initialize [pyenv](#Python 3.8).

On macOS and Linux, including WSL2, activate the environment using

```shell
$ source venv/bin/activate
```
Expand Down
Binary file modified README.pdf
Binary file not shown.

0 comments on commit 8c7ac01

Please sign in to comment.