Getting Started

Welcome to the domain deployment installation tutorials! This section of our documentation is designed to be the simplest way to get you started deploying your data to a domain node on an OSX, Linux, or Windows machine and interacting with it as a data scientist using PySyft.


If you’re looking for cloud deployment, or more advanced tutorials such as ansible, vagrant, kubernetes, or virtualbox deployment, please see the advanced deployment documentation.

The purpose of these tutorials is to help you install everything you need to run a Domain node from your personal machine (such as if you’re running through OpenMined courses or tutorials). To that end, we will also be installing everything you might need to run Jupyter notebooks with PySyft installed, such as if you’re pretending to be both Data Owner and Data Scientist as a part of a tutorial or course.

We will be setting up the following dependencies before PySyft and PyGrid:

  • Python >=3.9

  • pip

  • Conda

  • Jupyter notebook

  • Docker

If you already have all of them, jump here!

What OS are you on?

If you are unsure about the above, don’t worry, we got you covered. The first step of your journey is to figure out which operating system you are running and choose the right tutorial for installation. There are 3 types of operating systems for you to choose from:

  1. OSX

  2. Linux

  3. Windows

Best of luck on your journey!


If your Operating System is not listed here, feel free to drop us a query on Slack and we will get back to you.