Installation

System requirements

Python (version >= 3.6).
(For linux only) X11 system. Make sure other GUI programs (such as xeyes) works properly. For Windows users using Windows Subsystem for Linux (WSL), it is recommended to use xvcsrv (https://sourceforge.net/projects/vcxsrv/) as X11 client.

It is encouraged to use virtual environment to avoid conflict. You can skip this section if you want to install lys directly.

Open shell (we assume bash in linux). Go to home directory (or arbitrary directory you want to create virutual environment).
Create .venv directory and create “lys” (or arbitrary name you want) environment:
```
mkdir .venv
cd .venv
python -m venv lys
```
Activate the environment:
```
source lys/bin/activate
```

Update pip:
```
pip install --upgrade pip
```
Install lys by pip:
```
pip install lys-python
```
Start lys by the command below. Note that the current directory of the system is used as the working directory of lys:
```
python -m lys
```
If you want to enable parallel computing, start lys with -n option:
```
python -m lys -n [number of cores]
```

If you want to install lys from source, follow the instructions below. In particular, this is recommended if you want to use Automated test.

Update pip:
```
pip install --upgrade pip
```
Clone lys. If you do not have git, you can download the source code from GitHub (https://github.com/lys-devel/lys):
```
git clone git@github.com:lys-devel/lys.git
```
Install lys by pip. If you want to install lys in development mode, add -e option after pip install:
```
cd lys
pip install .
```
(Optional) If you want to check installation, go to Automated test.
Start lys by the command below. Note that the current directory of the system is used as the working directory of lys:
```
python -m lys
```
If you want to enable parallel computing, start lys with -n option:
```
python -m lys -n [number of cores]
```

We confirmed that lys works well under the environment below. If lys does not work, try the library versions below.

Python 3.6.8

Python 3.11.5