Home

Welcome to the lovelace-engine wiki!

How to Set Up Your Engine Development Environment

1. Install Python 3.6 and pip if you don't already have them:

   • Ubuntu/Debian: sudo apt-get install python-pip
   • Arch Linux: sudo pacman -S python-pip
   • See https://packaging.python.org/install_requirements_linux/ for other Linux distributions

2. Install virtualenv if you don't already have it: sudo pip install virtualenv

3. Go to the root of the lovelace-engine repo: cd /path/to/lovelace-engine

4. Create the virtual environment: make prepare-venv

5. Create a soft link to the problem files: ln -s /path/to/lovelace-problems/problems ./problems

6. Create a soft link to the tutorial files: ln -s /path/to/lovelace-problems/tutorials ./tutorials

7. That's it! Just make sure to execute source env/bin/activate whenever you need to explicitly use the virtual environment.

Sources:

• https://blog.dbrgn.ch/2012/9/18/virtualenv-quickstart/
• https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/

How to Install New Libraries

1. Make sure you're virtual environment is set up: make prepare-venv
2. Install the new library using pip: env/bin/pip install <library-name>. If you've activated the virtual environment using source env/bin/activate, you can shorten env/bin/pip to just pip.
3. Update the requirements.txt file in our repository with the new library: make update-requirements
4. After you've pushed your changes to requirements.txt, other developers will also have the library when setting up their environment.

How to Install the Engine on FreeBSD

1. Download the Engine repo: cd ~ ; git clone https://github.com/project-lovelace/lovelace-engine.git
2. Set up the virtual environment: cd ~/lovelace-engine ; make prepare-venv
3. Test that the Engine works: make start-engine
4. Set up the Engine as a service: a.