Versions Compared

Key

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

...

Follow the guidelines found here: Setting Up Docker

4. Setup Scripts

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

To make installs easier, there is a python script found in the our embedded-base repo that will install and build every python and rust package, along with building our docker image

  1. Clone Embedded Base

To do this, you'll need to setup ssh keys on your machine. If you aren’t sure how to do this, take a look at some of our git resources linked further down in this doc, or the many resources online that can walk through this

  1. Open the Embedded-Base repo, and run

Code Block
python setup.py

...

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, adds some aliases, and a few other small things. 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.

...