User guide
==========


Run Locally
-----------

.. note::

    To set up the project on your machine, follow these steps:

1. **Install TeachOpenCADD:**
   Open your terminal and clone the repository:

   .. code-block:: bash

      pip install teachopencadd


2. **Execute notebooks:**
   Run the following command.

   .. code-block:: bash

       teachopencadd 1

   Here, ``1`` is the ID referring to the talktorial to execute.

   It will take a couple of minutes if you're running a particular notebook for the very first time. First, the system will internally create a Conda virtual environment and install all necessary Python packages; you can monitor the progress logs in the terminal. Then, the notebook will launch in your browser.