Skip to content

Commit

Permalink
📝 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AmineDjeghri committed Jan 5, 2024
1 parent f312f64 commit eab945d
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/docs_instance.tree
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

<toc-element topic="README.md" toc-title="Home"/>
<toc-element topic="README_windows.md">
<toc-element topic="1_cuda_pytorch_install.md"/>
<toc-element topic="2_pycharm_wsl_conda.md"/>
<toc-element topic="1_cuda_pytorch_install.md" toc-title="1. cuda, pytorch setup with conda"/>
<toc-element topic="2_pycharm_wsl_conda.md" toc-title="2/ Pycharm, wsl setup"/>
</toc-element>
<toc-element topic="README_unix.md"/>
<toc-element topic="browser_extensions.md" toc-title="Browser extensions"/>
Expand Down
11 changes: 2 additions & 9 deletions docs/unix_workflow/1_cuda_pytorch_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,7 @@ Installing CUDA inside a Conda environment instead of globally on your computer

3. Clean Uninstall: If you later decide to remove a project and its associated dependencies, it's straightforward to delete the Conda environment, which ensures a clean uninstallation without leaving traces on your system.


## Summary
1. [Install the Nvidia driver](#1-install-the-nvidia-driver)

2. [Recommended Option: Installing CUDA Inside a Conda Environment](#2-recommended-option-installing-cuda-inside-a-conda-environment)
* [Automatic installation](#2-1-automatic-installation)
* [Manual installation ](#2-2-manual-installation)

** table of content **


## 1. Install the Nvidia driver
Expand All @@ -35,7 +28,7 @@ Linux example:
# Display GPU information
nvidia-smi
```
## 2. Recommended Option: Installing CUDA Inside a Conda Environment
## 2. Installing CUDA Inside a Conda Environment

#### 2.1. Automatic installation :
Create an environment with CUDA support by executing the command. The conda-env-gpu.yml file is used to create a Conda environment for running your project on a GPU. It specifies the Python version, some Conda packages, and references the requirements-cuda.txt file for additional Python packages.
Expand Down
15 changes: 7 additions & 8 deletions docs/unix_workflow/2_pycharm_wsl_conda.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,13 @@ Some of them are re-mapped :
| next word: | Ctrl+Right | |
| previous word | Ctrl+Left | |

## 1.3. Python remote interpreter (SSH /WSL)
- add a remote python interpreter: usually found with `which python` on the remote server or WSL.
- PyCharm envs: You can clean out old PyCharm interpreters that are no longer associated with a project see the image [here](https://github.com/AmineDjeghri/BetterWindowsUX/blob/master/pycharm_interpreters.PNG) .
- This gives you a listing where you can get rid of old virtualenvs that PyCharm thinks are still around


## 1.3. Pycharm remote deployment
## 1.4. Pycharm remote deployment
WARNING: project folder needs to be on windows and not WSL to use the remote ssh. Do not host folders outside WSL if you are not using a remote interpreter, there are [WSL perforamance issues](https://github.com/microsoft/WSL/issues/4197?notification_referrer_id=MDE4Ok5vdGlmaWNhdGlvblRocmVhZDUyMzA5ODA3MjozMjcxNTkxMw%3D%3D#issuecomment-1727108838))

Defining a server as default:
Expand All @@ -84,17 +88,12 @@ Open the deployment Options (Settings/Preferences | Deployment | Options or Tool
In the main menu, select Tools | Deployment | Automatic upload. Note that automatic upload in this case is performed in the Always mode.


## 1.4. Python remote interpreter
- add a remote python interpreter: usually found with `which python` on the remote server.
- PyCharm envs: You can clean out old PyCharm interpreters that are no longer associated with a project see the image [here](https://github.com/AmineDjeghri/BetterWindowsUX/blob/master/pycharm_interpreters.PNG) .
- This gives you a listing where you can get rid of old virtualenvs that PyCharm thinks are still around

## 1.5. Remote SSH for ReactJS
- First make sure that in the server, the React project is running when you run `yarn dev run`
- First, make sure that in the server, the React project is running when you run `yarn dev run`
- In pycharm, go to configuration and create a new config for npm
- select package.json from the local folder
- select command: run
- select scripts: dev
- Node interpreter: copy and paste the result of the command `which node` in the remote server
- package manager: yarn, for example
- environment : `PATH=` put the result of the command `echo $PATH`
- environment: `PATH=` put the result of the command `echo $PATH`
2 changes: 1 addition & 1 deletion docs/unix_workflow/auto_linux_setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ install_oh_my_zsh_and_utilities() {
echo "${YELLOW} ----------------------------------------------------Information---------------------------------------------------------------------- ${RESET}"
echo "${YELLOW} New ${RED}.zshrc ${YELLOW} file has been created with the new configuration. ${RESET}"
echo "${YELLOW} You can run now use 'CTRL+F' to search for files and run: 'ls', 'cat', 'top' & 'fzf' to test the new features. ${RESET}"
echo "${YELLOW} If fzf or ctrl+f do not work correctly, copy this command: ${RED} emulate sh -c 'source /etc/profile.d/apps-bin-path.sh'${YELLOW} in ${RED}/etc/zsh/zprofile ${RESET}"
echo "${YELLOW} If fz or ctrl+f do not work correctly, copy this command (careful with Apostrophes in the command) : ${RED} emulate sh -c 'source /etc/profile.d/apps-bin-path.sh'${YELLOW} in ${RED}/etc/zsh/zprofile ${RESET}"
echo "${YELLOW} If ls & top commands do not work, please close and open a new terminal ${RESET}"
echo "${YELLOW} -------------------------------------------------------------------------------------------------------------------------------------- ${RESET}"

Expand Down
2 changes: 1 addition & 1 deletion docs/windows_workflow/README_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can follow this repository to get a similar setup.

**Table of Contents**
<!-- TOC -->
* [Awesome Windows11 & WSL](#awesome-windows11--wsl)
* [Windows & WSL setup](#windows--wsl-setup)
* [1. Windows account & configuration](#1-windows-account--configuration)
* [1.1. Windows account](#11-windows-account)
* [1.2. Windows configuration](#12-windows-configuration)
Expand Down

0 comments on commit eab945d

Please sign in to comment.