"use strict";(self.webpackChunksynthonneldocusaurus=self.webpackChunksynthonneldocusaurus||[]).push([[3976],{1512:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var i=t(4848),r=t(8453);const s={sidebar_position:1},l="Quick Start Guide",o={id:"intro",title:"Quick Start Guide",description:"Synthonnel is Open Source, licensed under Creative Commons Attribution 4.0 International.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"User Guide",permalink:"/docs/category/user-guide"}},a={},d=[{value:"What is "Synthonnel"?",id:"what-is-synthonnel",level:4},{value:"What is a "Parley"?",id:"what-is-a-parley",level:4},{value:"Download the exe!",id:"download-the-exe",level:2},{value:"Install and Run Synthonnel from Source Code.",id:"install-and-run-synthonnel-from-source-code",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"Step 1: Download Source from GitHub",id:"step-1-download-source-from-github",level:2},{value:"Step 2: Create and Activate Virtual Environment",id:"step-2-create-and-activate-virtual-environment",level:2},{value:"Step 3: Install Requirements",id:"step-3-install-requirements",level:2},{value:"Step 4: Start FastAPI Backend",id:"step-4-start-fastapi-backend",level:2},{value:"Step 5: Access the User Interface",id:"step-5-access-the-user-interface",level:2},{value:"Step 6: Parley!",id:"step-6-parley",level:2}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h4:"h4",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"quick-start-guide",children:"Quick Start Guide"}),"\n",(0,i.jsx)(n.p,{children:"Synthonnel is Open Source, licensed under Creative Commons Attribution 4.0 International."}),"\n",(0,i.jsx)(n.h4,{id:"what-is-synthonnel",children:'What is "Synthonnel"?'}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"Synthonnel"})," is a portmanteau of ",(0,i.jsx)(n.strong,{children:"synth"}),"etic pers",(0,i.jsx)(n.strong,{children:"onnel"})," used to represent the concept of a personnel department to manage all the synthetic workers."]}),"\n",(0,i.jsx)(n.h4,{id:"what-is-a-parley",children:'What is a "Parley"?'}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.em,{children:"Parley"})," is the whole multidimensional conversation of prompts and responses from the various active LLMs selected to participate."]}),"\n",(0,i.jsxs)(n.p,{children:["So add a few models, ask a couple questions, receive your responses.. baby you got a ",(0,i.jsx)(n.em,{children:"Parley"})," going!"]}),"\n",(0,i.jsx)(n.h2,{id:"download-the-exe",children:"Download the exe!"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Download the release from GitHub.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/twadeclark/Synthonnel/releases",children:"https://github.com/twadeclark/Synthonnel/releases"})}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.li,{children:"Unzip the file."}),"\n",(0,i.jsx)(n.li,{children:"Open the folder and double-click Synthonnel.exe"}),"\n",(0,i.jsx)(n.li,{children:"Parley!"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"install-and-run-synthonnel-from-source-code",children:"Install and Run Synthonnel from Source Code."}),"\n",(0,i.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Ensure you have ",(0,i.jsx)(n.a,{href:"https://git-scm.com/downloads",children:"Git"})," installed for downloading the source code."]}),"\n",(0,i.jsxs)(n.li,{children:["Make sure ",(0,i.jsx)(n.a,{href:"https://www.python.org/downloads/",children:"Python"})," is installed on your system."]}),"\n",(0,i.jsx)(n.li,{children:"It is recommended to use a virtual environment for managing project dependencies."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"step-1-download-source-from-github",children:"Step 1: Download Source from GitHub"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Open a terminal and navigate to the desired directory."}),"\n",(0,i.jsx)(n.li,{children:"Run the following command to clone the repository:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"git clone https://github.com/twadeclark/Synthonnel.git\n"})}),"\n",(0,i.jsx)(n.h2,{id:"step-2-create-and-activate-virtual-environment",children:"Step 2: Create and Activate Virtual Environment"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Create a virtual environment using the following command:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"python -m venv venv\n"})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:"Activate the virtual environment with the appropriate command based on your operating system:"}),"\n"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Windows"}),":"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:".\\venv\\Scripts\\activate\n"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"macOS/Linux"}),":"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"source venv/bin/activate\n"})}),"\n",(0,i.jsx)(n.h2,{id:"step-3-install-requirements",children:"Step 3: Install Requirements"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Install the required packages by running:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"pip install -r requirements.txt\n"})}),"\n",(0,i.jsx)(n.h2,{id:"step-4-start-fastapi-backend",children:"Step 4: Start FastAPI Backend"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Start the FastAPI backend using the following command:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"uvicorn main:app --reload\n"})}),"\n",(0,i.jsx)(n.h2,{id:"step-5-access-the-user-interface",children:"Step 5: Access the User Interface"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Open your web browser and visit the following URL:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"http://127.0.0.1:8000/\n"})}),"\n",(0,i.jsx)(n.h2,{id:"step-6-parley",children:"Step 6: Parley!"}),"\n",(0,i.jsx)(n.p,{children:"Now you should be able to see and interact with Synthonnel. Enjoy!"})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>o});var i=t(6540);const r={},s=i.createContext(r);function l(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);