rianadutta / IMAGE-server

IMAGE project server components
Other
0 stars 0 forks source link

help writing a preprocessor #16

Open rianadutta opened 1 year ago

rianadutta commented 1 year ago

Automated message from DevMate: Hi! I might have found a solution for your problem. Of course! I'd be happy to help you write a preprocessor. Preprocessors in the IMAGE project are used to modify or preprocess data before it is sent to the client application.

To get started, you can follow these steps:

  1. Clone the IMAGE-server repository from GitHub:

    git clone --recurse-submodules git@github.com:Shared-Reality-Lab/IMAGE-server.git
  2. Navigate to the directory of the preprocessor you want to modify. For example, if you want to modify the "hello-preprocessor", you can go to:

    cd IMAGE-server/preprocessors/hello-preprocessor
  3. Create a new branch for your modifications:

    git checkout -b test_preprocessor

    Note: It's recommended to use your user ID as a prefix to anything you create, such as USERID_test_preprocessor, to differentiate it from others.

  4. You can now start modifying the preprocessor code to suit your needs. The Dockerfile in the preprocessor directory creates an image capable of running your code. Make sure to understand the purpose and functionality of the preprocessor you are working on before making any changes.

Remember, the IMAGEData provided here is just a reference, and it's always a good idea to consult the official documentation and resources available for the IMAGE project at McGill University for more detailed instructions and guidelines.