oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2369: missed items

Browse Source
This commit is contained in:
Czar Echavez
2024-03-15 13:13:54 +00:00
parent 1d09f0791a
commit 1ed2f48f54
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/example_notebooks.rst
View File

@@ -5,7 +5,7 @@
Example Jupyter Notebooks Example Jupyter Notebooks
========================= =========================
There are a few example notebooks included which helps with the understanding of PrimAITE's capabilities. There are a few example notebooks included which help with the understanding of PrimAITE's capabilities.
The Jupyter Notebooks can be run via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started <getting-started>` page is completed as a prerequisite. The Jupyter Notebooks can be run via the 2 examples below. These assume that the instructions to install PrimAITE from the :ref:`Getting Started <getting-started>` page is completed as a prerequisite.
@@ -57,6 +57,8 @@ Running Jupyter Notebooks via VSCode
It is also possible to view the Jupyter notebooks within VSCode. It is also possible to view the Jupyter notebooks within VSCode.
The best place to start is by opening a notebook file (.ipynb) in VSCode. If using VSCode to view a notebook for the first time, follow the steps below.
Installing extensions Installing extensions
""""""""""""""""""""" """""""""""""""""""""
@@ -77,3 +79,5 @@ The following extensions should now be installed
:align: center :align: center
VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.8 - 3.10 VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.8 - 3.10
You should now be able to interact with the notebook.

2
docs/source/getting_started.rst
View File

@@ -57,7 +57,7 @@ Install PrimAITE
.. code-block:: powershell .. code-block:: powershell
:caption: Windows (Powershell) :caption: Windows (Powershell)
cd ~\primaite\3.0.0 cd ~\primaite\{VERSION}
python3 -m venv .venv python3 -m venv .venv
attrib +h .venv /s /d # Hides the .venv directory attrib +h .venv /s /d # Hides the .venv directory