{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Installation\n",
    "\n",
    "ObsPlus *Should* run on all the major operating systems.\n",
    "\n",
    "There are a few options for installing ObsPlus:\n",
    "\n",
    "## 1) Conda\n",
    "\n",
    "ObsPlus is on [conda-forge](https://conda-forge.org/). Conda is the easiest method to install ObsPlus.\n",
    "\n",
    "```bash\n",
    "\n",
    "conda install obsplus -c conda-forge\n",
    "```\n",
    "\n",
    "## 2) Pip\n",
    "\n",
    "ObsPlus is on PyPi, use pip to install the most recent release:\n",
    "\n",
    "```bash\n",
    "pip install obsplus\n",
    "```\n",
    "\n",
    "## 3) From source\n",
    "\n",
    "For the most up-to-date version, install from source (master).\n",
    "\n",
    "First clone the source repo\n",
    "\n",
    "```bash\n",
    "git clone https://github.com/niosh-mining/obsplus\n",
    "cd obsplus\n",
    "```\n",
    "\n",
    "then install with pip\n",
    "\n",
    "```bash\n",
    "pip install .\n",
    "```\n",
    "\n",
    "or install in development mode if you plan to [contribute](contributing.ipynb)\n",
    "\n",
    "```bash\n",
    "pip install -e .[dev]\n",
    "```\n",
    "\n",
    "No other installation options are supported."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}