=========================
PyEnvBuilder Walk-through
=========================


Local Workflow - Development
-----------------------------

1. install pyenvbuilder::

	pip install pyenvbuilder

2. create an environment YAML file: *my_env.yml*

Simple YAML file contents example:: 

    name: python3.7env
    version: v0.1
    conda_packages:
            - python=3.7 


3. validate *my_env.yml*::

	pyenvbuilder check my_env.yml


4. create the environment *my_env.yml*::

	pyenvbuilder create my_env.yml

After this you should have an environment called:

	**python3.7env_v0.1**


5. pack the environment::

	pyenvbuilder pack python3.7env_v0.1

This step will pack the environment into a tarball:

	**python3.7env_v0.1.tar.gz**


------------------------------

Local Workflow - Deployment
-----------------------------

1. install pyenvbuilder::

	pip install pyenvbuilder

2. unpack an environenment::

	pyenvbuilder unpack python3.7env_v0.1.tar.gz

After this step you should have an environment called: 

	**python3.7env_v0.1**

To activate the environment run::

	source python3.7env_v0.1/bin/activate


.. note:: You do not need pyenvbuilder to unpack an environment, you can manually do it:
	::

          	mkdir python3.7env_v0.1
      		tar -xzf python3.7env_v0.1.gz -C python3.7env_v0.1
      		source python3.7env_v0.1/bin/activate
      		conda-unpack
      		source python3.7env_v0.1/bin/deactivate

------------------------------


* *Development & Deployment Diagram*

.. image:: _static/images/workflow.png
   :width: 600pt
   :align: center