Vapaunic/envname (#61)

* renamed conda env

* modified setup instructions

* minor change in contributing guide

CONTRIBUTING.md

@@ -2,11 +2,16 @@
 
 Contribution are welcome! Here's a few things to know:
 
+* [Setup](./SETUP.md)
 * [Microsoft Contributor License Agreement](#microsoft-contributor-license-agreement)
 * [Steps to Contributing](#steps-to-contributing)
 * [Coding Guidelines](#forecasting-team-contribution-guidelines)
 * [Code of Conduct](#code-of-conduct)
 
+
+## Setup
+To get started, navigate to the [Setup Guide](./SETUP.md), which lists instructions on how to set up your environment and dependencies.
+
 ## Microsoft Contributor License Agreement
 
 Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

SETUP.md

@@ -16,7 +16,7 @@ conda env create -f tools/environment.yaml
 ```
 This will create the appropriate conda environment to run experiments. Next activate the installed environment:
 ```bash
-conda activate forecast
+conda activate forecasting_env
 ```
 
 During development, in case you need to update the environment due to a conda env file change, you can run
@@ -45,8 +45,8 @@ This repository provides examples on how to run various forecasting algorithms o
 #### Notebooks
 We provide example notebooks under `examples/` to demonstrate how to train and evaluate forecasting algorithms.
 
-Make sure to run the notebooks in the conda environment we previously set up (`forecast`). To register the conda environment in Jupyter, please run:
+Make sure to run the notebooks in the conda environment we previously set up (`forecasting_env`). To register the conda environment in Jupyter, please run:
 
 ```
-python -m ipykernel install --user --name forecast
+python -m ipykernel install --user --name forecasting_env
 ```

tools/environment.yml

@@ -8,10 +8,10 @@
 # $ conda env update -f environment.yaml
 #
 # To register the conda environment in Jupyter:
-# $ conda activate forecast
-# $ python -m ipykernel install --user --name forecast
+# $ conda activate forecasting_env
+# $ python -m ipykernel install --user --name forecasting_env
 
-name: forecast
+name: forecasting_env
 channels:
   - defaults
   - conda-forge
@@ -36,5 +36,4 @@ dependencies:
     - jupytext==1.3.0
     - lightgbm==2.3.1
     - nteract-scrapbook==0.3.1
-    - gitpython==3.0.5
-    # - fire==0.2.1 # for CLI capabilities
+    - gitpython==3.0.5