Installation ============ To install PyProBE you must be running Python 3.11 or later. It is recommended to use a virtual environment to install PyProBE, for example venv or conda. .. dropdown:: If you are completely new to Python **Recommended software** The easiest way to get started with data processing in Python is to use `Anaconda `_ for package management and `Visual Studio Code `_ for code editing. You will need `Git `_ installed to clone the repository. If you are new to Git version control, the `GitHub Desktop `_ is a good place to start. In order to follow the installation instructions below, on Windows you can work in Anaconda Prompt. On Mac or Linux you can use Terminal directly. **Using PyProBE after installation** Jupyter Notebooks are a popular format for Python data processing. VSCode has support for writing and running these, which you can open from the dropdown menu: .. image:: images/VSCode_open_file.png You should then select the Anaconda environment that you will create from the list of available Python environments: .. image:: images/VSCode_select_kernel.png The steps to install PyProBE are as follows: 1. Create and activate a virtual environment. .. tabs:: .. tab:: venv In your working directory: .. code-block:: bash python -m venv venv source .venv/bin/activate .. tab:: conda In any directory: .. code-block:: bash conda create -n pyprobe python=3.12 conda activate pyprobe 2. Install PyProBE with pip: .. code-block:: bash pip install PyProBE-Data Optional dependencies can be added to the installation as follows: .. code-block:: bash pip install 'PyProBE-Data[hvplot]' If a method uses an optional dependency, it will be detailed in the :doc:`api documentation `. If these methods are run without their dependencies installed, they will return an error. 3. You can create a new python script or jupyter notebook to process your data. You can import PyProBE into your script as follows: .. code-block:: python import pyprobe 4. Before being able to launch the dashboard you will need to initialise streamlit. Do this by running the streamlit Hello app from your command line: .. code-block:: bash streamlit hello .. footbibliography::