From 8b2dec3983214eda55b910e982e5f00a7dfbacb0 Mon Sep 17 00:00:00 2001 From: Igor Tona Peres <87746221+igor-peres@users.noreply.github.com> Date: Fri, 4 Oct 2024 10:14:38 -0300 Subject: [PATCH] Update vertex_starting.html --- docs/vertex_starting.html | 100 ++++++++++++++++++++++++++++++++++---- 1 file changed, 91 insertions(+), 9 deletions(-) diff --git a/docs/vertex_starting.html b/docs/vertex_starting.html index 3d6a5bd..5fd17ff 100644 --- a/docs/vertex_starting.html +++ b/docs/vertex_starting.html @@ -102,16 +102,98 @@

Introduction

This guide will help you set up a VERTEX dashboard on your local machine, and explore the existing pipelines.

-

Automatic Installation

+

Automatic Installation For Windows

-

Download and run the installer file VERTEX_Win_AutoInstaller.exe in any location on your computer. Wait for a terminal window to open, and a sequence of commands will execute. The installation process takes about 10 minutes. You don't need to keep the window maximized (it can be minimized while the process runs).

- -

Possible issues:

- +

What does it do?

+

This is an automatic installer specifically made for the Windows operating system.If you use macOS or Linux, please refer to the manual installation guide, as the auto-installer is still being developed.

+ +

First, the program will install Git on your computer. Git is a tool that works like a time machine for your project, allowing you to save, track changes, and revert to previous versions if needed. After installing Git, it will install Pyenv and the Vertex program using Git, by cloning their repository in GitHub. Pyenv is a tool that lets you easily switch between different versions of Python on your computer, helping manage multiple Python versions for different projects without conflicts.

+ +

The installer will also add Pyenv’s path to your system's account variables. In simple terms, this lets your computer know that Pyenv is installed without altering anything else. After that, it will install Python version 3.12.6, followed by the VERTEX platform. Both VERTEX and Pyenv will be installed in your user folder.

+ +

Below is an slideshow example of how to access your user folder:

+ +

Steps to Locate the .pyenv Folder

+
+ +   + + +
+
1 / 5
+ +
+
+
2 / 5
+ +
+
+
3 / 5
+ +
+
+
4 / 5
+ +
+
+
5 / 5
+ +
+
+ +
+
+ + + +
+ + + + +
    +
  1. Start by opening File Explorer. You can find its icon in the taskbar or by searching for it in the Start menu. In the left sidebar, click on This PC to access your computer’s main drives.
    2. +
  2. Open your C: drive (this might be labeled as SSD or something similar, depending on your setup).
    3. +
  3. Navigate to the Users directory, where all user profiles are stored. In my case, it's named Usuarios.
    4. +
  4. Find and open your personal user folder. For instance, mine is called luizr, but your folder name might be different.
    5. +
  5. Inside your user folder, look for the .pyenv directory. This is where VERTEX and other Python environments may be installed.
    6. +
+ +

When the installation is complete, you will have the option to run or not run VERTEX. Unfortunately, it does not automatically open the web page you need. Please wait for about 2 to 5 minutes, depending on your internet connection, and then manually search for http://127.0.0.1:8050 in any web browser, such as Google Chrome, Firefox, etc. You may also click in the hyperlink that automatically directs you to http://127.0.0.1:8050

+ +

Installation Process

+

Download and run the installer file VERTEX_Win_AutoInstaller.exe in any location on your computer, wait for a terminal window to open, and a sequence of commands will execute. The installation process takes about 10 minutes. You don’t need to keep the window maximized (it can be minimized while the process runs). It’s also important to note that there will be text prompts during the execution, explaining what is happening at each stage.

+ +

Possible issues:

+

Manual Installation