Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 2.39 KB

setup.md

File metadata and controls

61 lines (50 loc) · 2.39 KB
Raw

Setting up your system to run and modify lvv-ri

Anaconda:

We recommend installing Python via the Anaconda Distribution. Be sure to use the "Python 3.6" version or higher. We will use the Conda Package Management System within the Anaconda Distribution. From the documentation:

Conda is an open source package management system and environment management system that runs on Windows, macOS and Linux. Conda quickly installs, runs and updates packages and their dependencies. Conda easily creates, saves, loads and switches between environments on your local computer.

After the installation run python --version in a terminal window (in "Anaconda Prompt" if you are using Windows). If the output show "Python 3.6.x" or "Python 3.7.x" and "Anaconda" you are good to go.

GitHub:

The code is hosted on the code-sharing platform GitHub (where you now are reading this). If you do not have a GitHub account already you should make one. We recommend that you are using this platform for you own projects. https://github.com/join.

Install and test the lvv-ri environment:

After you have successfully installed Anaconda, go through the following steps (if you are using Windows, be at the "Anaconda Prompt").

Install Git

conda install git

Download the repository:

git clone https://github.com/arvidl/lvv-ri
cd lvv-ri

Configure the Python-environment:

conda env update

Activate the environment:

conda activate lvv-ri

If you are using Linux or MacOS and the command above fails, type

source ~/.bash_profile

and try conda activate lvv-ri again. If this fails, activate the environment by typing source activate lvv-ri instead.

Install a Jupyter kernel:

python -m ipykernel install --user --name lvv-ri --display-name "LVV-RI"

Test your installation:

Go through the notebook 0.0-test.ipynb in the notebooks-directory:

cd notebooks
jupyter notebook

You can also use JupyterLab: jupyter lab.

Update:

The code and environment might be updated to account for errors and improvements - the paper and the accompanying code (as accepted) can be regarded as a snapshot. To consider this, run the following commands:

  • Update code: git pull
  • Update environment:
conda activate lvv-ri
conda env update