Skip to content

Commit

Permalink
Added descrition on how to use virtual environment (#309)
Browse files Browse the repository at this point in the history
  • Loading branch information
bubeck authored Sep 13, 2024
1 parent 6c76df6 commit c4bf983
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,6 @@ coverage.xml
docs/_build/

tests/welt2000/data/WELT2000.TXT

# Virtual Environment for python
.env
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,22 @@ Development Environment
-----------------------

If you want to work on aerofiles you should install the necessary dependencies
using::
using pip, preferably in a virtual environment::

$ python -m venv .env
$ source .env/bin/activate
$ pip install -r requirements-dev.txt

You can run the testsuite with::

$ make test

If you close the current shell, the virtual python environment will
also be deactivated. To continue working in the environment and using
the installed requirements, you must use this again::
$ source .env/bin/activate

Building Docs
-------------

Expand Down

0 comments on commit c4bf983

Please sign in to comment.