Setting Up

WSL 2

Skip this if you are running Linux or if you are using a Cloud IDE like Cloud9 or Gitpod.

Windows Subsystem for Linux.

Highly recommended as this is an easy way to have Linux running on your windows 10 PC.

See Windows Subsystem for Linux Installation Guide for Windows 10

AWS Code Commit (Git)

Skip if you are using Cloud9.

Ensure Git is installed. Dowload Git

Setup AWS credential helper:

git config --global credential.helper '!aws codecommit credential-helper $@'
git config --global credential.UseHttpPath true

The Git credential helper writes the following value to ~/.gitconfig:

[credential]
    helper = !aws codecommit credential-helper $@
    UseHttpPath = true

See AWS Docs for more detail.

Clone the repo

git clone https://git-codecommit.eu-west-1.amazonaws.com/v1/repos/emagine-epython

Setup your Python environment

Python

On CentOS or AWS EC2/Cloud9:

Find source from https://www.python.org/downloads/source/

wget https://www.python.org/ftp/python/3.8.6/Python-3.8.6.tgz
cd Python-3.8.6
sudo ./configure --enable-optimizations
sudo make altinstall

On Ubuntu or WSL:

sudo apt update && upgrade
sudo apt install python3 python3-pip ipython3

On Windows:

Download the installer.

virtualenvwrapper

See Instructions for installation:

Create a virtual environment.

mkvirtualenv epython

From now on each time you want to work on the your project you would do

workon epython

You could also switch to your other project using workon.

cd into your repository:

cd emagine-epython

Add path to virtual env and set project:

add2virtualenv $(pwd)
setvirtualenvproject emagine-epython $(pwd)

Installing Libraries

Upgrade pip

pip install -U pip

Install requirements:

pip install -r requirements.txt

IDE

VSCode

Document Building

In order to build Jupyter notebook into sphinx we would need to install pandoc

sudo apt-get install texlive texlive-latex-extra pandoc