Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Install Python through the official installer

    1. Download the Python installer from https://www.python.org/downloads/ .

    2. Run the installer, and make sure to check the box that says "Add Python to PATH."

    3. Follow the installation prompts.

  2. Install Rust through the official installer

    1. Download and run the Rust installer from https://rust-lang.org/ .

    2. Follow the installation prompts.

2. Install Git

Same deal with package managers as above, but generally:

Mac

Code Block
brew install git

Linux

Code Block
sudo apt install git

Windows

  1. Download git from the official installer https://gitforwindows.org/

  2. Run the .exe and follow the steps

3. Install and setup Docker (all platforms)

Follow the guidelines found here: Setting Up Docker

3.

...

Setup

Info

It is strongly recommended to maintain a directory structure like the following

> NER
> NER Repo 1
> NER Repo 2


This ensures that the virtual environment will be placed at the same directory level as all repos, which happens automatically if setup like above

...

This script sets up a python virtual environment, installs packages within it, and binds the running of the docker container to the opening/closing of this virtual environment. For a list of tools that we use, take a look at the next section.

  1. Set up shell aliases
    This is by no means mandatory, but it might be helpful and is a bit hard to automate in the above script. If you’d like to save time activating and de-activating the virtual environment, you can alias these commands for whichever shell you are using For now, I’m not going to walk through instructions for doing this here; there’s many shells you all might be using, and a million ways to do this, but if you are unsure of how to do it feel free to ask someone and they can help you through it.

Developing on our Team

Overview

...