Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT: add installation guide #114

Merged
merged 1 commit into from
Nov 24, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
}