/nebari-docs

📖 Documentation for nebari

BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Nebari logo mark - text will be black in light color mode and white in dark color mode.


Information Links
Project LicenseNebari documentation PyPI version
Community GH discussions Open an issue Nebari documentation - Community guidelines
CI Kubernetes Tests Tests Netlify Status

Nebari is a customizable Data Science and MLOps platform designed as a managed integration of open source technologies. It uses an infrastructure-as-code approach to quickly and smoothly deploy a shared data science environment, on premises or in the cloud of choice. Nebari is an opinionated open source JupyterHub distribution with a variety of common integrations to help you and your team get set up with all your favorite tools... and a few you didn't know you needed!

To get started with Nebari right away, check the Nebari documentation!


Table of contents

Nebari 101 ⚡

Nebari Cloud can be deployed on any Kubernetes cluster by leveraging these tools:

Nebari aims to abstract all these complexities for its users. Hence, it is not necessary to know any of the above mentioned technologies to have your project successfully deployed.

TLD;R If you know GitHub/GitLab and feel comfortable generating and using API keys, you should have all it takes to deploy and maintain your system without the need for a dedicated DevOps team. No need to learn Kubernetes, Terraform, or Helm.

Nebari on-prem

We also have a version of Nebari based on OpenHPC. It can be used to deploy onto HPC systems or on bare-metal.

Note This tool is currently under development. Curious? Check out the Nebari HPC repository.

Installation 💻

Nebari is supported by macOS and Linux operating systems (Windows is NOT currently supported). It is compatible with Python 3.7+. We also suggest you use virtual environments such as (conda, pipenv or venv).

Depending on where you are planning to deploy, Nebari can be installed and deployed in roughly 30 minutes!

*Note Check the Nebari installation guide for detailed step-by-step instructions on deploying Nebari.

Contributing to Nebari 👩‍💻

Thinking about contributing? Check out our Contribution Guidelines to get started.

Installing the Development version of Nebari ⚙️

To install the latest developer version (unstable) use:

pip install git+https://github.com/nebari-dev/nebari.git

Contributing to the documentation 📝

To build the docs locally, follow the guide in the docs README.

Questions? 🤔

Have a look at our Frequently Asked Questions (FAQ) to see if your query has been answered.

Getting help:

  • GitHub Discussions is our user forum. It can be used to raise discussions about a subject, such as: "What is the recommended way to do X with Nebari?"

  • Issues for queries, bug reporting, feature requests, documentation, etc.

We work around the clock to make Nebari better, but sometimes your query might take a while to get a reply. We apologize in advance and ask you to please, be patient 🙏.

Code of Conduct 📖

To guarantee a welcoming and friendly community, we require all community members to follow our Code of Conduct.

License

Nebari is licensed under the BSD-3 OSI license.