Skip to content

Commit

Permalink
simpler setup
Browse files Browse the repository at this point in the history
  • Loading branch information
rland93 committed Apr 24, 2020
1 parent 76a107a commit 0c22d11
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 23 deletions.
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,14 @@ https://rland93.github.io/uciAPC/documentation/index.html
# Installation

## Environment setup
Clone this repository into a new directory:
Clone this repository wherever.

git clone https://github.com/rland93/uciAPC.git

Create a new virtual environment:
Create a new [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) and activate it.

MacOS and Linux:

python3 -m venv venv

Windows:

python3 -m venv venv

Activate the virtual environment:

MacOS and Linux:

source venv/bin/activate

On Windows:

.\venv\Scripts\activate

Install dependencies from ```requirements.txt```:
Install dependencies from ```requirements.txt```.

pip install -r requirements.txt

done!
4 changes: 2 additions & 2 deletions docs/_posts/2020-04-24-refactoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ tags: [visualiation, progress report]

#### Analysis:
+ Charts are now functionally generated, instead of scripted
+ charts now are saved to disk individually rather than in one file
+ Charts now are saved to disk individually rather than in one file

#### Package:
+ Numpy-style docstrings added
+ added requirements.txt

I'm most excited about the new documentation and ~parallell~ ~processing~ that works now. We can run simulations much more accurately now.
I'm most excited about the new documentation and ~parallell~ ~processing~ that works now. We can run simulations much much faster now.

0 comments on commit 0c22d11

Please sign in to comment.