...

Step-by-Step Instructions

1. Install prerequisite software. The install methods will depend on your operating system:
   
   1. VirtualBox (or an equivalent Docker-compatible virtualization environment)
   2. Docker
   3. Python and PIP
      

2. Clone this extractor template project from this the repository, substituting your extractor project name:

   Code Block
   language bash
   git clone http://bitbucket.ncsa.illinois.edu/path/to/extractor-template.git <extractor project name>

3. Create and activate a Python virtual environment for their new project:
   

   1. Code Block
      language bash
      cd <extractor project name> virtualenv myextractor. source myextractor/bin/activate pip install docker-compose

      NOTE: To activate this Python virtual environment in the future, repeat the "source bin/activate" step.

4. Start up the Extractor runtime environment using Docker Compose:
   

   1. TODO: docker-compose.yml for extractor runtime environment

      Code Block
      language bash
      cd myextractor docker-compose up ./run-tests.py (or something like that)

   2. Runtime containers for extractors: Clowder instance
   3. Runtime containers for converters: Polyglot instance