From 6b0182c10279749ccb6920c7ee6734037b8398d3 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Tue, 30 Aug 2022 23:50:29 -0700 Subject: [PATCH] update README --- README.md | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 91bf355..709e13a 100644 --- a/README.md +++ b/README.md @@ -48,45 +48,36 @@ linear systems, ideally with double precision. **Requirements:** -* python 3 (tests require 3.7) +* python >=3.8 * numpy * scipy Install from PyPI with pip: ```bash -pip3 install 'meanas[test,examples]' +pip3 install 'meanas[dev]' ``` ### Development install -Install python3.7, virtualenv, and git: +Install python3 and git: ```bash # This is for Debian/Ubuntu/other-apt-based systems; you may need an alternative command -sudo apt install python3.7 virtualenv build-essential python3.7-dev git -``` - -If python 3.7 is not your default python3 version, create a virtualenv: -```bash -# Check python3 version: -python3 --version -# output on my system: Python 3.7.5rc1 -# If this indicates a version >= 3.7, you can skip all -# the steps involving virtualenv or referencing the venv/ directory - -# Create a virtual environment using python3.7 and place it in the directory `venv/` -virtualenv -p python3.7 venv +sudo apt install python3 build-essential python3-dev git ``` In-place development install: ```bash # Download using git -#git clone https://mpxd.net/code/jan/meanas.git +git clone https://mpxd.net/code/jan/meanas.git + +# If you'd like to create a virtualenv, do so: +python3 -m venv my_venv # If you are using a virtualenv, activate it -source venv/bin/activate +source my_venv/bin/activate -# Install in-place (-e, editable) from ./meanas, including testing and example dependencies ([test, examples]) -pip3 install --user -e './meanas[test,examples]' +# Install in-place (-e, editable) from ./meanas, including development dependencies ([dev]) +pip3 install --user -e './meanas[dev]' # Run tests cd meanas @@ -95,7 +86,7 @@ python3 -m pytest -rsxX | tee test_results.txt #### See also: - [git book](https://git-scm.com/book/en/v2) -- [virtualenv documentation](https://virtualenv.pypa.io/en/stable/userguide/) +- [venv documentation](https://docs.python.org/3/tutorial/venv.html) - [python language reference](https://docs.python.org/3/reference/index.html) - [python standard library](https://docs.python.org/3/library/index.html)