updated readme for setting up env

[joshkenney]

Hi,

Spoke with JT Colonel today and we are interested in using this for our OpenFace analysis. Trying to figure out how to get started but documentation is a little spotty

Is there documentation for setting up?

If not, happy to work on documentation as I get this set up. Just need a little more information from the maintainer

Josh

[dheshanm]

Hi Josh,

Unfortunately, documentation is deficient on how to set this up and would appreciate any help you can provide on this!

As for how the code base is structured, we have:

• PostgreSQL DB
  • Responsible for tracking the various stages of processing for each 'interview'
  • Holds the 'state' of the processing, allowing other components to be relatively 'stateless'
• Crawlers
  • responsible for populating the DB with interview information
• Runners
  • responsible for various processing tasks (like Metadata extraction, splitting videos, running OpenFace etc.)

We have numbered the files under these folders to indicate the order in which data is processed. And the various different config files used for different projects are also included as *.config.ini files at the root of this repo.

To get started, a high-level summary would be:

• creating a config.ini fine at the root of the repo with parameters specific to your project and DB credentials
• Initialize the DB with the included script
• Import data to the DB using the 'crawlers'
• Start Processing the data using the 'runners'

Some other things to note are:

• The current iteration of the pipeline expects a certain 'PHOENIX' structure to be able to use the included crawlers and runners with minimal change. If this is not the case with your data, a few code changes may be necessary

Please let me know if you need any more information / clarification from me!

[joshkenney]

Thanks for this! This will help us get started. Given the distributed nature of the app I'll create a docker image.

If I understand correctly, once dpinterview architecture is assembled, dpinterview-web sits on top?

[dheshanm]

Yes, dpinterview-web interacts with the DB for most of its functionality and additionally with a file-server to serve / view the video / audio files for QC purposes.