From 685c81fa40e3a3b0aa7727c9f045fe0bf36a2be7 Mon Sep 17 00:00:00 2001 From: Sergi Delgado Segura Date: Wed, 18 Mar 2020 17:08:40 +0100 Subject: [PATCH] Updates repo name to not match server-side name. Updates INSTALL --- INSTALL.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index a0593a8..e615ac3 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -5,25 +5,25 @@ There are two ways of running `teos`: adding the library to the `PYTHONPATH` env variable, or running it as a module. ## Modifying `PYTHONPATH` -In order to run `teos`, you should set your `PYTHONPATH` env variable to include the **outer** teos folder. You can do so by running: +In order to run `teos`, you should set your `PYTHONPATH` env variable to include the teos parent folder. You can do so by running: - export PYTHONPATH=$PYTHONPATH: + export PYTHONPATH=$PYTHONPATH: For example, for user alice running a UNIX system and having `teos` in her home folder, she would run: - export PYTHONPATH=$PYTHONPATH:/home/alice/teos/ + export PYTHONPATH=$PYTHONPATH:/home/alice/ You should also include the command in your `.bashrc` to avoid having to run it every time you open a new terminal. You can do it by running: - echo 'export PYTHONPATH=$PYTHONPATH:' >> ~/.bashrc + echo 'export PYTHONPATH=$PYTHONPATH:' >> ~/.bashrc Once the `PYTHONPATH` is set, you should be able to run `teos` straightaway. Try it by running: - cd /teos/ + cd /teos/ python teosd.py ## Running `teos` as a module -Python code can be also run as a module, to do so you need to use `python -m`. From the **outer** teos directory run: +Python code can be also run as a module, to do so you need to use `python -m`. From the teos parent directory run: python -m teos.teosd @@ -32,4 +32,4 @@ Notice that if you run `teos` as a module, you'll need to replace all the calls ## Modify configuration parameters If you'd like to modify some of the configuration defaults (such as the user directory, where the logs will be stored) you can do so in the config file located at: - /teos/conf.py + /teos/conf.py