diff --git a/docs/installation.rst b/docs/installation.rst index 4c8fa965..147ccfe1 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -2,68 +2,9 @@ Installation ******************************************************************************** -Conda -===== +.. toctree:: + :maxdepth: 1 + :titlesonly: + :glob: -Create environment ------------------- - -.. code-block:: bash - - conda create -n compas_wood_3_9_10 python=3.9.10 compas - conda activate compas_wood_3_9_10 - - -Clone and install compas_wood ------------------------------ - -.. code-block:: bash - - git clone https://github.com/petrasvestartas/compas_wood.git - cd compas_wood - pip install -r requirements.txt - pip install -e . - - -Display via compas_viewer -------------------------- - - -.. code-block:: bash - - git clone https://github.com/compas-dev/compas_viewer.git - cd compas_viewer - conda activate compas_wood_3_9_10 - pip install -e . - - -Visual Studio Code ------------------- - -- Launch ``VSCode`` and select the ``compas_wood_3_9_10`` Python environment using ``CTRL+SHIFT+P``. -- Open a new terminal via ``Terminal -> New Terminal``. -- Navigate to the ``docs/examples`` folder and execute any ``.py`` example file by right-clicking and selecting ``Run Python File in Terminal``. - -.. figure:: /_images/vscode_environment.gif - :figclass: figure - :class: figure-img img-fluid - -Notes -===== - -If you are new to Anaconda World, install these tools first: - -- `Anaconda `_ - -- `Visual Studio Code `_ - -- `Git `_ - - - - -.. Pip -.. === -.. .. code-block:: bash - -.. pip install compas_wood + installation/* diff --git a/docs/installation/conda.rst b/docs/installation/conda.rst new file mode 100644 index 00000000..90649888 --- /dev/null +++ b/docs/installation/conda.rst @@ -0,0 +1,57 @@ +******************************************************************************** +Conda +******************************************************************************** + +Create environment +------------------ + +.. code-block:: bash + + conda create -n compas_wood_3_9_10 python=3.9.10 compas + conda activate compas_wood_3_9_10 + + +Clone and install compas_wood +----------------------------- + +.. code-block:: bash + + git clone https://github.com/petrasvestartas/compas_wood.git + cd compas_wood + pip install -r requirements.txt + pip install -e . + + +Display via compas_viewer +------------------------- + + +.. code-block:: bash + + git clone https://github.com/compas-dev/compas_viewer.git + cd compas_viewer + conda activate compas_wood_3_9_10 + pip install -e . + + +Visual Studio Code +------------------ + +- Launch ``VSCode`` and select the ``compas_wood_3_9_10`` Python environment using ``CTRL+SHIFT+P``. +- Open a new terminal via ``Terminal -> New Terminal``. +- Navigate to the ``docs/examples`` folder and execute any ``.py`` example file by right-clicking and selecting ``Run Python File in Terminal``. + +.. figure:: /_images/vscode_environment.gif + :figclass: figure + :class: figure-img img-fluid + +Notes +===== + +If you are new to Anaconda World, install these tools first: + +- `Anaconda `_ + +- `Visual Studio Code `_ + +- `Git `_ \ No newline at end of file diff --git a/docs/installation/pip.rst b/docs/installation/pip.rst new file mode 100644 index 00000000..fda3f00d --- /dev/null +++ b/docs/installation/pip.rst @@ -0,0 +1,11 @@ +******************************************************************************** +Pip +******************************************************************************** + +If you already have a working Python environment: + +.. code-block:: bash + + pip install compas_wood + +Note: compatible with Python version 3.9.10 and above. \ No newline at end of file