Skip to content

Commit

Permalink
Merge pull request #114 from Nixtla/feat/install-guide
Browse files Browse the repository at this point in the history
FEAT: add installation guide
  • Loading branch information
mergenthaler authored Nov 24, 2022
2 parents 82a793e + 0b8e66d commit 68e46be
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions nbs/examples/Installation.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "14f5686c-449b-4376-8c58-fc8141f4b0f8",
"metadata": {},
"source": [
"# Install\n",
"\n",
"> Install HierachicalForecast with pip or conda"
]
},
{
"cell_type": "markdown",
"id": "0f1d1483-6da7-4372-8390-84c9c280109e",
"metadata": {},
"source": [
"You can install the *released version* of `HierachicalForecast` from the [Python package index](https://pypi.org) with:\n",
"\n",
"```python\n",
"pip install hierachicalforecast\n",
"```\n",
"\n",
"or \n",
"\n",
"```python\n",
"conda install -c conda-forge hierachicalforecast\n",
"``` \n",
"\n",
":::{.callout-tip}\n",
"We recommend installing your libraries inside a python virtual or [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html).\n",
":::\n",
"\n",
"#### User our env (optional)\n",
"\n",
"If you don't have a Conda environment and need tools like Numba, Pandas, NumPy, Jupyter, StatsModels, and Nbdev you can use ours by following these steps:\n",
"\n",
"1. Clone the HierachicalForecast repo: \n",
"\n",
"```bash \n",
"$ git clone https://github.com/Nixtla/hierachicalforecast.git && cd hierachicalforecast\n",
"```\n",
"\n",
"2. Create the environment using the `environment.yml` file: \n",
"\n",
"```bash \n",
"$ conda env create -f environment.yml\n",
"```\n",
"\n",
"3. Activate the environment:\n",
"```bash\n",
"$ conda activate statsforecast\n",
"```"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
}
},
"nbformat": 4,
"nbformat_minor": 5
}

0 comments on commit 68e46be

Please sign in to comment.