Install

This section describes how to install cLASpy_T.

Install Python 3

cLASpy_T is based on Python 3. It needs a Python 3.10 64-bit interpreter version installed, or earlier.

See the Download section of the beginners Guide from the Python documentation.

Install cLASpy_T on Linux

Get cLASpy_T source code

First, open a terminal and move to the directory in which cLASpy_T source code will be clone. For example, ‘Me’ user moves to his ‘Code’ directory, then get the cLASpy_T source code with the git command to clone ‘cLASpy_T.git’:

me@pc:~$ cd Code
me@pc:~/Code$ git clone https://github.com/TrickyPells/cLASpy_T.git

Note

If you do not know what git is, you can download cLASpy_T source code on the github page. Choose the branch you want to download and click Code on the right, then Download ZIP. Once downloaded, decompress the ZIP file in the directory you want.

Once you clone or download/decompress source code, move to the cLASpy_T directory:

me@pc:~/Code$ cd cLASpy_T

Create a Virtual Environment

Python uses many packages, depending of your usages. To prevent a dirty installation and package incompatibilities, it could be a great idea to use virtual environments. Here, you will create a specific virtual environment for cLASpy_T.

First, create a new directory called .venv and use venv command from python to create a new virtual environment called claspy_venv:

me@pc:~/Code/cLASpy_T$ mkdir .venv
me@pc:~/Code/cLASpy_T$ python -m venv .venv/claspy_venv

Now, you can use this new virtual environment:

me@pc:~/Code/cLASpy_T$ source .venv/claspy_venv/bin/activate

Your terminal must return something like this:

(claspy_venv) me@pc:~/Code/cLASpy_T$

If you want to deactivate the virtual environment, juste type:

(claspy_venv) me@pc:~/Code/cLASpy_T$ deactivate

Install all dependencies

All required packages are listed in the requirements.txt file. We will use pip command to install all dependencies automatically.

If no terminal already open, open one, move to the cLASpy_T directory and activate the virtual environment created earlier.

Check if pip needs to be upgraded:

(claspy_venv) me@pc:~/Code/cLASpy_T$ python -m pip install --upgrade pip

Once done, install all dependencies:

(claspy_venv) me@pc:~/Code/cLASpy_T$ python -m pip install -r requirements.txt

Now, with pip list command, you should see all packages installed in this venv. It should look something like this:

(claspy_venv) me@pc:~/Code/cLASpy_T$ pip list
Package                       Version
  ----------------------------- -----------
  colorclass                    2.2.2
  contourpy                     1.2.0
  cycler                        0.12.1
  fonttools                     4.50.0
  joblib                        1.3.2
  kiwisolver                    1.4.5
  laspy                         2.5.3
  matplotlib                    3.8.3
  numpy                         1.26.4
  packaging                     24.0
  pandas                        2.2.1
  pillow                        10.3.0
  pip                           24.3.1
  psutil                        5.9.8
  pyparsing                     3.1.2
  PyQt5                         5.15.10
  PyQt5-Qt                      5.15.2
  PyQt5-Qt5                     5.15.2
  PyQt5-sip                     12.13.0
  PyQt5-stubs                   5.15.6.0
  python-dateutil               2.9.0.post0
  pytz                          2024.1
  PyYAML                        6.0.1
  requests                      2.31.0
  scikit-learn                  1.5.0
  scipy                         1.12.0
  six                           1.16.0
  threadpoolctl                 3.4.0
  tzdata                        2024.1

Well done ! Your installation of cLASpy_T is now clomplete !

You can start by following /tutorials/tutorial1 to quickly discover cLASpy_T and test its installation. You can also visit the Command line to find out more about cLASpy_T commands and usages.

Install cLASpy_T on Windows

Get cLASpy_T source code

First, open the Command Prompt cmd.exe. You can easily open it by clicking Start, then search cmd.

Once the Command Prompt open, move to the directory in which the cLASpy_T source code will be clone. For example, ‘Me’ user moves to his Code directory and gets the cLASpy_T source code with the git command to clone ‘cLASpy_T.git’:

C:\Users\Me>cd Code
C:\Users\Me\Code>git clone https://github.com/TrickyPells/cLASpy_T.git

Note

If you do not know what git is, you can download cLASpy_T source code on the github page. Choose the branch you want to download and click Code on the right, then Download ZIP. Once downloaded, decompress the ZIP file in the directory you want.

Once you clone or download/decompress source code, move to the cLASpy_T directory:

C:\Users\Me\Code>cd cLASpy_T

Create a Virtual Environment

Python uses many packages, depending of your usages. To prevent a dirty installation and package incompatibilities, it could be a great idea to use virtual environments. Here, we will create a specific virutal environment for cLASpy_T.

First, create a new directory called .venv and use venv command from python to create a new virtual environment called claspy_venv:

C:\Users\Me\Code\cLASpy_T>mkdir .venv
C:\Users\Me\Code\cLASpy_T>python -m venv .venv\claspy_venv

Now, you can use this new virtual environment:

C:\Users\Me\Code\cLASpy_T>.venv\claspy_venv\Scripts\activate

Your Command Prompt must return something like this:

(claspy_venv) C:\Users\Me\Code\cLASpy_T>

To deactivate the virtual environment, juste type:

(claspy_venv) C:\Users\Me\Code\cLASpy_T>deactivate

Install all dependencies

All required packages are listed in the requirements.txt file. We will use pip command to install these dependencies automatically.

If no Command Prompt already open, open one, move to the cLASpy_T directory and activate the virtual environment created earlier.

Check if pip needs to be upgraded:

(claspy_venv) C:\Users\Me\Code\cLASpy_T>python -m pip install --upgrade pip

Once donce, install all dependencies:

(claspy_venv) C:\Users\Me\Code\cLASpy_T>python -m pip install -r requirements.txt

Now, with pip list command, you should see all packages installed in this venv. It should look something like this:

(claspy_venv) C:\Users\Me\Code\cLASpy_T>pip list
Package                       Version
  ----------------------------- -----------
  colorclass                    2.2.2
  contourpy                     1.2.0
  cycler                        0.12.1
  fonttools                     4.50.0
  joblib                        1.3.2
  kiwisolver                    1.4.5
  laspy                         2.5.3
  matplotlib                    3.8.3
  numpy                         1.26.4
  packaging                     24.0
  pandas                        2.2.1
  pillow                        10.3.0
  pip                           24.3.1
  psutil                        5.9.8
  pyparsing                     3.1.2
  PyQt5                         5.15.10
  PyQt5-Qt                      5.15.2
  PyQt5-Qt5                     5.15.2
  PyQt5-sip                     12.13.0
  PyQt5-stubs                   5.15.6.0
  python-dateutil               2.9.0.post0
  pytz                          2024.1
  PyYAML                        6.0.1
  requests                      2.31.0
  scikit-learn                  1.5.0
  scipy                         1.12.0
  six                           1.16.0
  threadpoolctl                 3.4.0
  tzdata                        2024.1

Well done ! Your installation of cLASpy_T is now clomplete !

You can start by following /tutorials/tutorial1 to quickly discover cLASpy_T and test its installation. You can also visit the Command line to find out more about cLASpy_T commands and usages.