Pull Request Details:

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/source/requirements.txt

README.md

@@ -1,8 +1,56 @@
-# pipeline_vsdi
+<h1 align="center">
+<img src="https://images.squarespace-cdn.com/content/v1/6172d4d5e7f28f6b50179b1b/c3b7cc24-51a1-44aa-8b39-b5e94ac01e8d/image+%282%29.png">
+<br>Pipeline VSDI
+</h1><br>
+
 Preprocessing tools for voltage sensitive dye imaging data
 
 ## Structure
 
-- vsdi will contain classes for handling sessions and full datasets
-- preprocessing contains functionality to clean and reshape data
-- dim_reduction contains functionality to reduce the dimensionality of the data with different models
+- **vsdi** - Contains classes for handling sessions and full datasets.
+- **preprocessing** - Contains functionality to clean and reshape data.
+- **dim_reduction** - Contains functionality to reduce the dimensionality of the data with different models.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.7 or higher
+- [Poetry](https://python-poetry.org/docs/#installation) Python packaging and dependency management tool.
+
+### Steps
+
+#### 1. Clone the repository
+
+```bash
+git clone https://github.com/dabadav/pipeline_vsdi.git
+cd pipeline_vsdi
+```
+
+#### 2. Install the package using Poetry
+
+Ensure you're in the `pipeline_vsdi` directory (or the directory where you cloned your repository) and run:
+
+```bash
+poetry install
+```
+
+This command installs all the dependencies specified in the `pyproject.toml` file in a new virtual environment. If you want to use the virtual environment for other tasks, you can activate it using:
+
+```bash
+poetry shell
+```
+
+After this, you should have all the necessary dependencies installed and be able to use the functionality provided by the Pipeline VSDI.
+
+## Usage
+
+After installation, you can import and use the tools in the Python interpreter or your scripts like:
+
+```python
+from vsdi import Session
+from preprocessing import clean_data
+from dim_reduction import reduce_dimension
+
+# Use the tools as per your requirement.
+```