[DOCS][CLEANUP]

pull/532/merge
Kye Gomez 6 months ago
parent 4860fcd046
commit 15b5f26f0a

@ -1,3 +1,6 @@
# Swarms Installation Guide
<div align="center"> <div align="center">
<p> <p>
<a align="center" href="" target="_blank"> <a align="center" href="" target="_blank">
@ -9,78 +12,135 @@
</p> </p>
</div> </div>
# Installation Guide
You can install `swarms` with pip in a You can install `swarms` with pip in a
[**Python>=3.10**](https://www.python.org/) environment. [**Python>=3.10**](https://www.python.org/) environment.
!!! example "pip install (recommended)" ## Prerequisites
=== "headless" Before you begin, ensure you have the following installed:
The headless installation of `swarms` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
```bash - Python 3.10 or higher: [Download Python](https://www.python.org/)
pip install swarms - pip (specific version recommended): `pip >= 21.0`
``` - git (for cloning the repository): [Download Git](https://git-scm.com/)
## Installation Options
=== "pip (Recommended)"
!!! example "git clone (for development)" #### Headless Installation
=== "virtualenv" The headless installation of `swarms` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
```bash ```bash
# clone repository and navigate to root directory pip install swarms
git clone https://github.com/kyegomez/swarms.git ```
cd swarms
# setup python environment and activate it === "Development Installation"
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
# headless install === "Using virtualenv"
pip install -e "."
# desktop install 1. **Clone the repository and navigate to the root directory:**
pip install -e ".[desktop]"
```
=== "poetry" ```bash
git clone https://github.com/kyegomez/swarms.git
cd swarms
```
```bash 2. **Setup Python environment and activate it:**
# clone repository and navigate to root directory
git clone https://github.com/kyegomez/swarms.git
cd swarms
# setup python environment and activate it ```bash
poetry env use python3.10 python3 -m venv venv
poetry shell source venv/bin/activate
pip install --upgrade pip
```
# headless install 3. **Install Swarms:**
poetry install
# desktop install - Headless install:
poetry install --extras "desktop"
```
```bash
pip install -e .
```
# Javascript - Desktop install:
!!! example "NPM install |WIP|" ```bash
pip install -e .[desktop]
```
=== "headless" === "Using Anaconda"
Get started with the NPM implementation of Swarms with this command:
```bash 1. **Create and activate an Anaconda environment:**
npm install swarms-js
```
```bash
conda create -n swarms python=3.10
conda activate swarms
```
## Documentation 2. **Clone the repository and navigate to the root directory:**
```bash
git clone https://github.com/kyegomez/swarms.git
cd swarms
```
3. **Install Swarms:**
- Headless install:
```bash
pip install -e .
```
- Desktop install:
```bash
pip install -e .[desktop]
```
=== "Using Poetry"
1. **Clone the repository and navigate to the root directory:**
```bash
git clone https://github.com/kyegomez/swarms.git
cd swarms
```
[Learn more about swarms →](swarms/) 2. **Setup Python environment and activate it:**
```bash
poetry env use python3.10
poetry shell
```
3. **Install Swarms:**
- Headless install:
```bash
poetry install
```
- Desktop install:
```bash
poetry install --extras "desktop"
```
## Javascript
=== "NPM install (Work in Progress)"
Get started with the NPM implementation of Swarms:
```bash
npm install swarms-js
```
## Documentation
[Learn more about Swarms →](swarms/)
## Examples ## Examples

Loading…
Cancel
Save