TNO Intern

Commit e80572f9 authored by Arjo Segers's avatar Arjo Segers
Browse files

Updated installation instructions.

parent de7d092a
Loading
Loading
Loading
Loading
+34 −16
Original line number Diff line number Diff line
@@ -25,6 +25,8 @@ A documentation is available online via the *Gitlab Pages*:

It is updated automatically when changes are pushed.

For first introduction, see in particular the [Tutorial](https://cams.ci.tno.nl/cso/tutorial.html) chapter.

Eventually create a local version of the documentation from its source files using:

    make docu
@@ -37,40 +39,56 @@ Note that the documenation requires 'sphinx',
which is usually part of your python distribution.


Installation from source
------------------------
Running CSO within your own Python environment
----------------------------------------------

The CSO tools could be started within the users own Pytthon environment.
The user should then ensure that the required (versions of) packages have been installed.

To test CSO within your environment, try for example run the example from the Tutorial:

    ./bin/cso config/tutorial/tutorial.rc

CSO can be installed from source in either conda or virtual environments.

**Pip**

The file py_project.toml contains the dependencies needed by CSO.  

Running CSO within a virtual environment
----------------------------------------

A *virtual environment* could be created that has all required (versions) of Python packages installed.
For this, the `py_project.toml` file is included which contains the dependencies needed by CSO.  

To create a new virtual enviroment run:

    python3 -m venv --prompt cso .venv

This will create a new Python evironment folder called `cso`. To activate it run
This will create a new Python evironment folder called `.venv`.
To activate it run:

    source .venv/bin/activate

You may need to updated pip with the command
The terminal prompt will then be preceded by `(cso)` which holds the name specified above 
with the `--prompt` argument.

You may need to upgrade `pip` with the command:

    pip install -U pip
    pip install --upgrade pip

We can then install CSO and its dependencies simply using pip
We can then install CSO and its dependencies into the virtual environment using:

    pip install -e .
    pip install --editable .

The `-e` flag installs CSO in editable mode, meaning that the user can change the source code and run CSO anywhere using these changes.
The `--editable` flag installs CSO in editable mode, meaning that the user can change the source code 
in the `src/` directory and run CSO anywhere using these changes.

Test the installation using the Tutorial settings:

Tutorial
--------
    ./bin/cso config/tutorial/tutorial.rc

A tutorial is included in the documentation.
When finished, leave from the virtual environment using:

For the impatient:
    deactivate

    ./bin/cso rc/tutorial.rc