merge

Author: Leah Wasser

.gitignore

@@ -1,4 +1,4 @@
-#
+.mypy_cache/
 .DS_Store
-3.6
 .nbgrader.log
+3.6

Dockerfile

@@ -4,13 +4,11 @@ MAINTAINER Leah Wasser <leah.wasser@colorado.edu>
 
 COPY environment.yml environment.yml
 
-RUN conda env update -n root -f environment.yml
-
-RUN conda info --envs
-
-RUN conda list
+RUN conda env update -n root -f environment.yml \
+  && conda info --envs \
+  && conda list \
+  && rm environment.yml
 
+# Test imports
 RUN python -c "import rasterio"
 RUN python -c "import earthpy"
-
-RUN rm environment.yml

README.md

@@ -7,7 +7,7 @@
 [![](https://images.microbadger.com/badges/image/earthlab/earth-analytics-python-env.svg)](https://microbadger.com/images/earthlab/earth-analytics-python-env "EA-Environment Docker Stats")
 ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/earthlab/earth-analytics-python-env?style=plastic)
 
-Welcome to the Earth Analytics Environment Repository! Here you will find a conda envt that can be installed on your computer using a `.yaml` file. You will also find a docker image that can be used to actually run the environment in a containerized environment.
+Welcome to the Earth Analytics `Python` Environment Repository! Here you will find a conda environment that can be installed on your computer using a `.yaml` file. You will also find a docker image that can be used to actually run the environment in a containerized environment.
 
 
 ## Contributors:
@@ -23,27 +23,40 @@ Welcome to the Earth Analytics Environment Repository! Here you will find a cond
 
 ### 1. Install the Earth Lab Conda Environment on your Local Computer.
 
-To begin, install git and conda for Python 3.x (we suggest 3.6).
+To begin, install `git` and `conda` for Python 3.x (we suggest 3.6).
 
 Installing git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
 
-Installing conda: https://www.anaconda.com/
-
-We recommend installing geo-related dependencies with `conda-forge`. We
-have created a custom yaml list with all of the dependencies that you will
-need to run the lessons in this course. Follow
-these steps below to get your environment ready.
+Installing miniconda: https://docs.conda.io/en/latest/miniconda.html
 
 About Conda Environments: https://conda.io/docs/user-guide/tasks/manage-environments.html
 
-An environment for conda has been created specifically for this course. To load it, run:
+### Tutorial On Setup
+If you want a more detailed tutorial on setting up this environment using miniconda, 
+please visit our learning portal: https://www.earthdatascience.org/workshops/setup-earth-analytics-python/
+
+We recommend installing everything using the with `conda-forge` channel. 
+
+### Quick Start: Setup Your Environment
+
+The tutorial above will provide you with more detailed setup instructions.
+But here are the cliff notes:
+
+To begin, install the environment using:
 
 `conda env create -f environment.yml`
 
-* Note that it takes a bit of time to run this setup
-* Also note that for the code above to work, you need to be in the directory where the `environment.yml` file lives (ex: cd earth-analytics-python-env).
+This will take a bit of time to run. 
+
+* Also note that for the code above to work, you need to be in the directory where the `environment.yml` file lives so CD to that directory first
+
+`$ cd earth-analytics-python-env`
+
+
+### Update Your EA Environment from the YAML File
+
+You can update your environment at any time using:
 
-To update this environment from a yaml file use:
 `conda env update -f environment.yml`
 
 To manage your conda environments, use the following commands:
@@ -58,20 +71,6 @@ To manage your conda environments, use the following commands:
 conda activate earth-analytics-python
 ```
 
-[Conda versions prior to 4.6:](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
-
-On Mac or Linux:
-
-```
-source activate earth-analytics-python
-```
-
-On Windows:
-
-```
-activate earth-analytics-python
-```
-
 The environment name is `earth-analytics-python` as
 defined in the `environment.yml` file.
 
@@ -111,19 +110,6 @@ into your browser to run jupyter with the earth analytics environment installed!
 If you wish to update the earth analytics environment, do the following.
 
 1. make a **PR** with changes to master
-2. **think** about your changes - don't do silly things or break things :)
-3. **merge** the PR into the master branch
-4. Check & wait till [Dockerhub](https://hub.docker.com/r/earthlab/earth-analytics-python-env/tags/) has built the image for the merging of the **PR** you can see builds in progress, [here](https://hub.docker.com/r/earthlab/earth-analytics-python-env/builds/)
-5. Finally, once the build is complete you can then you can update hub-ops repo with the newly tagged image.
-
-## Important Notes
-If the update the `earthpy` package, you must specify the commit number that you
-wish to build `earthpy` against. This will ensure that the docker image
-automagically rebuilds using the latest version of `earthpy`
-
-like this: `- git+https://github.com/earthlab/earthpy.git@283683affac9e46b1690c7913ebd2621c82ba43a`
-
-This PR should kick off a rebuild of the docker image. But that docker image will
-not be usable until it's built off of the master branch.
+1. An code admin will **merge** the PR into the master branch
+1. Check & wait till [Dockerhub](https://hub.docker.com/r/earthlab/earth-analytics-python-env/tags/) has built the image for the merging of the **PR** you can see builds in progress, [here](https://hub.docker.com/r/earthlab/earth-analytics-python-env/builds/)
 
-NOTE 2: The DockerHub build actually takes forever and ever. So it's best to check out the build status rather than assuming it's built.

hooks/build

@@ -2,4 +2,17 @@
 
 SHA=`git rev-parse --short HEAD`
 
-docker build -t earthlab/earth-analytics-python-env:$SHA .
+
+# Get current branch
+current_branch="$(git name-rev --name-only HEAD)"
+echo $current_branch
+
+if [ "$current_branch" == "master" ]
+then
+  # Create a tag for that commit number to use for tracking but also update latest
+  docker build -t earthlab/earth-analytics-python-env:$SHA .
+  docker build -t earthlab/earth-analytics-python-env:latest .
+else
+  # Create a tag for that particular branch
+  docker build -t earthlab/earth-analytics-python-env:$current_branch .
+fi

hooks/push

@@ -2,4 +2,17 @@
 
 SHA=`git rev-parse --short HEAD`
 
-docker push earthlab/earth-analytics-python-env:$SHA
+# Get current branch
+current_branch="$(git name-rev --name-only HEAD)"
+echo $current_branch
+
+if [ "$current_branch" == "master" ]
+then
+  # Create a tag for that commit number to use for tracking but also update latest
+  docker push earthlab/earth-analytics-python-env:$SHA
+  docker push earthlab/earth-analytics-python-env:latest
+else
+  # Push a tagged build for that particular branch only
+  # This will reduce the number of commit based tags in our environment
+  docker push earthlab/earth-analytics-python-env:$current_branch
+fi