diff --git a/README.md b/README.md index 97aacb3..ebfab73 100644 --- a/README.md +++ b/README.md @@ -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! \ No newline at end of file diff --git a/docs/_posts/2020-04-24-refactoring.md b/docs/_posts/2020-04-24-refactoring.md index db6f0bf..4c734d3 100644 --- a/docs/_posts/2020-04-24-refactoring.md +++ b/docs/_posts/2020-04-24-refactoring.md @@ -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. \ No newline at end of file +I'm most excited about the new documentation and ~parallell~ ~processing~ that works now. We can run simulations much much faster now. \ No newline at end of file