Commit e899e090 authored by Toni-SM's avatar Toni-SM Committed by Kelly Guo

Renames conda and venv Python environment to env_isaaclab (#188)

# Description

This PR renames conda and venv Python environment to `env_isaaclab`
Why? Following installation steps on Windows raise the following issue
because for Windows `isaaclab` (Python env) and `IsaacLab` (the repo) is
the same name. Also, this is more coherent with Isaac Sim's Python
environment names
(https://docs.omniverse.nvidia.com/isaacsim/latest/installation/install_python.html#installation-using-pip)


```
C:\Users\horde\Documents>dir
 Directory of C:\Users\horde\Documents

12/16/2024  02:50 PM    <DIR>          .
12/16/2024  02:50 PM    <DIR>          ..
12/13/2024  07:41 AM    <DIR>          isaaclab
               0 File(s)              0 bytes
               3 Dir(s)  172,079,185,920 bytes free

C:\Users\horde\Documents>git clone https://github.com/isaac-sim/IsaacLab.git
fatal: destination path 'IsaacLab' already exists and is not an empty directory.
```
parent 12d46410
...@@ -204,7 +204,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -204,7 +204,7 @@ Clone the Isaac Lab repository into your workspace:
-o, --docker Run the docker container helper script (docker/container.sh). -o, --docker Run the docker container helper script (docker/container.sh).
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
.. tab-item:: :icon:`fa-brands fa-windows` Windows .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
...@@ -224,7 +224,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -224,7 +224,7 @@ Clone the Isaac Lab repository into your workspace:
-t, --test Run all python unittest tests. -t, --test Run all python unittest tests.
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
Creating the Isaac Sim Symbolic Link Creating the Isaac Sim Symbolic Link
...@@ -289,7 +289,7 @@ use the following command: ...@@ -289,7 +289,7 @@ use the following command:
.. code:: bash .. code:: bash
# Option 1: Default name for conda environment is 'isaaclab' # Option 1: Default name for conda environment is 'env_isaaclab'
./isaaclab.sh --conda # or "./isaaclab.sh -c" ./isaaclab.sh --conda # or "./isaaclab.sh -c"
# Option 2: Custom name for conda environment # Option 2: Custom name for conda environment
./isaaclab.sh --conda my_env # or "./isaaclab.sh -c my_env" ./isaaclab.sh --conda my_env # or "./isaaclab.sh -c my_env"
...@@ -299,7 +299,7 @@ use the following command: ...@@ -299,7 +299,7 @@ use the following command:
.. code:: batch .. code:: batch
:: Option 1: Default name for conda environment is 'isaaclab' :: Option 1: Default name for conda environment is 'env_isaaclab'
isaaclab.bat --conda :: or "isaaclab.bat -c" isaaclab.bat --conda :: or "isaaclab.bat -c"
:: Option 2: Custom name for conda environment :: Option 2: Custom name for conda environment
isaaclab.bat --conda my_env :: or "isaaclab.bat -c my_env" isaaclab.bat --conda my_env :: or "isaaclab.bat -c my_env"
...@@ -310,7 +310,7 @@ activate the environment before running any scripts. For example: ...@@ -310,7 +310,7 @@ activate the environment before running any scripts. For example:
.. code:: bash .. code:: bash
conda activate isaaclab # or "conda activate my_env" conda activate env_isaaclab # or "conda activate my_env"
Once you are in the virtual environment, you do not need to use ``./isaaclab.sh -p`` / ``isaaclab.bat -p`` Once you are in the virtual environment, you do not need to use ``./isaaclab.sh -p`` / ``isaaclab.bat -p``
to run python scripts. You can use the default python executable in your environment to run python scripts. You can use the default python executable in your environment
......
...@@ -38,8 +38,8 @@ compatibility issues with some Linux distributions. If you encounter any issues, ...@@ -38,8 +38,8 @@ compatibility issues with some Linux distributions. If you encounter any issues,
.. code-block:: bash .. code-block:: bash
conda create -n isaaclab python=3.10 conda create -n env_isaaclab python=3.10
conda activate isaaclab conda activate env_isaaclab
.. tab-item:: venv environment .. tab-item:: venv environment
...@@ -51,20 +51,20 @@ compatibility issues with some Linux distributions. If you encounter any issues, ...@@ -51,20 +51,20 @@ compatibility issues with some Linux distributions. If you encounter any issues,
.. code-block:: bash .. code-block:: bash
# create a virtual environment named isaaclab with python3.10 # create a virtual environment named env_isaaclab with python3.10
python3.10 -m venv isaaclab python3.10 -m venv env_isaaclab
# activate the virtual environment # activate the virtual environment
source isaaclab/bin/activate source env_isaaclab/bin/activate
.. tab-item:: :icon:`fa-brands fa-windows` Windows .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
.. code-block:: batch .. code-block:: batch
# create a virtual environment named isaaclab with python3.10 # create a virtual environment named env_isaaclab with python3.10
python3.10 -m venv isaaclab python3.10 -m venv env_isaaclab
# activate the virtual environment # activate the virtual environment
isaaclab\Scripts\activate env_isaaclab\Scripts\activate
- Next, install a CUDA-enabled PyTorch 2.4.0 build based on the CUDA version available on your system. This step is optional for Linux, but required for Windows to ensure a CUDA-compatible version of PyTorch is installed. - Next, install a CUDA-enabled PyTorch 2.4.0 build based on the CUDA version available on your system. This step is optional for Linux, but required for Windows to ensure a CUDA-compatible version of PyTorch is installed.
...@@ -204,7 +204,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -204,7 +204,7 @@ Clone the Isaac Lab repository into your workspace:
-o, --docker Run the docker container helper script (docker/container.sh). -o, --docker Run the docker container helper script (docker/container.sh).
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
.. tab-item:: :icon:`fa-brands fa-windows` Windows .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
...@@ -224,7 +224,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -224,7 +224,7 @@ Clone the Isaac Lab repository into your workspace:
-t, --test Run all python unittest tests. -t, --test Run all python unittest tests.
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
Installation Installation
~~~~~~~~~~~~ ~~~~~~~~~~~~
......
...@@ -247,7 +247,7 @@ echo -s, --sim Run the simulator executable (isaac-sim.bat) provi ...@@ -247,7 +247,7 @@ echo -s, --sim Run the simulator executable (isaac-sim.bat) provi
echo -t, --test Run all python unittest tests. echo -t, --test Run all python unittest tests.
echo -v, --vscode Generate the VSCode settings file from template. echo -v, --vscode Generate the VSCode settings file from template.
echo -d, --docs Build the documentation from source using sphinx. echo -d, --docs Build the documentation from source using sphinx.
echo -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. echo -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
echo. echo.
goto :eof goto :eof
...@@ -328,8 +328,8 @@ if "%arg%"=="-i" ( ...@@ -328,8 +328,8 @@ if "%arg%"=="-i" (
set conda_env_name=%2 set conda_env_name=%2
shift shift
) else ( ) else (
echo [INFO] Using default conda environment name: isaaclab echo [INFO] Using default conda environment name: env_isaaclab
set conda_env_name=isaaclab set conda_env_name=env_isaaclab
) )
call :setup_conda_env %conda_env_name% call :setup_conda_env %conda_env_name%
shift shift
...@@ -340,8 +340,8 @@ if "%arg%"=="-i" ( ...@@ -340,8 +340,8 @@ if "%arg%"=="-i" (
set conda_env_name=%2 set conda_env_name=%2
shift shift
) else ( ) else (
echo [INFO] Using default conda environment name: isaaclab echo [INFO] Using default conda environment name: env_isaaclab
set conda_env_name=isaaclab set conda_env_name=env_isaaclab
) )
call :setup_conda_env %conda_env_name% call :setup_conda_env %conda_env_name%
shift shift
......
...@@ -241,7 +241,7 @@ print_help () { ...@@ -241,7 +241,7 @@ print_help () {
echo -e "\t-o, --docker Run the docker container helper script (docker/container.sh)." echo -e "\t-o, --docker Run the docker container helper script (docker/container.sh)."
echo -e "\t-v, --vscode Generate the VSCode settings file from template." echo -e "\t-v, --vscode Generate the VSCode settings file from template."
echo -e "\t-d, --docs Build the documentation from source using sphinx." echo -e "\t-d, --docs Build the documentation from source using sphinx."
echo -e "\t-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'." echo -e "\t-c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'."
echo -e "\n" >&2 echo -e "\n" >&2
} }
...@@ -307,8 +307,8 @@ while [[ $# -gt 0 ]]; do ...@@ -307,8 +307,8 @@ while [[ $# -gt 0 ]]; do
-c|--conda) -c|--conda)
# use default name if not provided # use default name if not provided
if [ -z "$2" ]; then if [ -z "$2" ]; then
echo "[INFO] Using default conda environment name: isaaclab" echo "[INFO] Using default conda environment name: env_isaaclab"
conda_env_name="isaaclab" conda_env_name="env_isaaclab"
else else
echo "[INFO] Using conda environment name: $2" echo "[INFO] Using conda environment name: $2"
conda_env_name=$2 conda_env_name=$2
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment