Getting Started with Odin

Getting Started with Docker

1. Download Odin from the GitHub repository.
2. Go to the odin folder you have just downloaded:

     cd path/to/odin
   

3. Build the odin image from the Dockerfile:

     docker build -t odin .
   

4. Run the container:

     docker run -it -p 8888:8888 odin
   

5. Go to the folder ‘home/examples’ from the Jupyter Notebook and try the ready-to-use notebooks.

Getting Started with Virtual Environment

1. Download Odin from the GitHub repository.
2. Go to the odin folder you have just downloaded:

     cd path/to/odin
   

3. Create a virtual environment:

     python -m venv venv
   

4. Activate the virtual environment just created:
   • On MacOS/Linux:

     source venv/bin/activate
     

   • On Windows:

     .\venv\Scripts\activate
     

5. Install the framework and its requirements:

     pip install -e . --user
   

6. N.B. To be able to use the meta-annotation extractor, two more packages need to be installed (tensorflow and mtcnn). Simply execute the following command:

     pip install tensorflow mtcnn
   

7. Start a Jupyter Notebook, go to the folder ‘examples’ and try the ready-to-use notebooks.