Added how to solve possible errors to WINDOWS_INSTALL.md

This commit is contained in:
Pilar 2022-05-10 12:13:52 -04:00
parent 58b097cee3
commit 6b10fdf9c0
4 changed files with 36 additions and 11 deletions

View File

@ -40,6 +40,13 @@ Finally, open a terminal and type 'conda init powershell'.
![terminal_conda](docs/img_windows_install/img_30.png)
**NOTE:** This final step could produce the following error:
_The term '...' is not recognized as the name of a cmdlet, function,..._
![error_conda](docs/img_windows_install/img_32.png)
To solve it, type 'Set-ExecutionPolicy Unrestricted' as shown in the image.
### Get a Python editor
1. You will need a python editor in order to import the existing Hub source code and to write your own python code.
@ -48,6 +55,10 @@ an excellent open-source python editor.
2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options,
but the default ones should be fine.
**NOTE:** If Pycharm asks you to create a Virtual Environment, click **Cancel**. You will do it later using Conda instead.
![creating_virtual_environment](docs/img_windows_install/img_31.png)
## Get the CERC Hub source code
1. Run PyCharmCE
@ -64,7 +75,7 @@ You can find it also at **Git->Clone...**
![pycharm get from version control screen](docs/img_windows_install/img_1.png)
(You can also copy this URL by going to the Hub repository in [Gitlab](https://rs-loy-gitlab.concordia.ca/Guille/hub.git)
and clicking on the Copy URL button next to **Clone with HTTPS**)
and clicking on the **Copy URL** button, next to **Clone with HTTPS**)
![gitlab get https](docs/img_windows_install/img_17.png)
@ -75,26 +86,39 @@ Note: If you see a message saying Git is not installed, click on the **Download
4. Click the **Clone** button to download CERC hub source code. You will then see the project directories and files below,
with the hub readme document displayed. You have successfully cloned a copy of the CERC hub onto your computer.
![pycharm project screen](docs/img_windows_install/img_2.png)
![pycharm_project_screen](docs/img_windows_install/img_2.png)
## Configure Python Interpreter
@Chris, this section is new
Click on **File**, and select **Settings...** from the drop-down menu. The Settings window will appear.
1. Click on **File**, and select **Settings...** from the drop-down menu. The Settings window will appear.
From the panel on the left, select **Project: hub->Python Interpreter** and you will see the following window:
![configure interpreter 1](docs/img_windows_install/img_22.png)
![configure_interpreter_1](docs/img_windows_install/img_22.png)
Click on the little gear on the right and click **Add...**. In the new window, click on **Conda Environment**,
2. Click on the little gear on the right and click **Add...**. In the new window, click on **Conda Environment**,
select **New environment** and the Python version 3.9.
![configure interpreter 2](docs/img_windows_install/img_25.png)
![configure_interpreter_2](docs/img_windows_install/img_25.png)
You should end with the following window:
![configure interpreter 3](docs/img_windows_install/img_26.png)
![configure_interpreter_3](docs/img_windows_install/img_26.png)
Click **OK** to close it and go to the Terminal (a tab in the bottom) to finish this process. You should see
Click **OK** to close it.
**NOTE:** This final step could produce the following error:
![conda_environment_error](docs/img_windows_install/img_33.png)
To solve it, add to the Path (as explained in [previous chapter Get Miniconda](WINDOWS_INSTALL.md#Get Miniconda))
the following paths:
* C:\Users\User\miniconda3\Library\bin
* C:\Users\User\miniconda3
* C:\Users\User\miniconda3\Scripts
Restart the computer and come back to step 1 of this section.
5. Go to the Terminal (a tab in the bottom) to finish this process. You should see
_PS C:\Users\Pilar\PycharmProjects\hub>_ preceded either by _(base)_ or _(hub)_. If non of those are there,
gbe sure that you have Miniconda installed and included in the path as explained in
[previous chapter Get Miniconda](WINDOWS_INSTALL.md#Get Miniconda). If not, do it, restart Pycharm, and come back to this point.
@ -163,7 +187,8 @@ See the picture below.
2. Choose the **Create blank project** option from the three options seen below.
3. Type in a name (remember to follow the CERC naming conventions described in the ![Coding Style](PYGUIDE.md)).
3. Type in a name that describes your project: _hp_workflow_, _bus_system_optimization_...
(remember to follow the CERC naming conventions described in the [Coding Style](PYGUIDE.md)).
Check the option **Initialize repository with a README**, and ideally, check the **Visibility Level** to be **Public**.
Then click on the **Create project** button.
@ -174,7 +199,7 @@ You should then see a confirmation screen with all the information about your ne
## Get your project into Pycharm
1. Now you can make a clone of this project, within PyCharm. First, copy the URL by clicking on the blue **Clone** button
and then click on the **Copy URL** button next to the **Clone with HTTPS** link.
and then click on the **Copy URL** button, next to the **Clone with HTTPS** link.
2. Switch back to PyCharm and close the Hub project by choosing **File->Close Project**. You will then see the
**Welcome To PyCharm** window again.

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB