missing setup instructions

[Balint Varga]

Hi,
thank you for sharing your code,
I'm excited about this work, and just wanted to give it a try, but could find no setup instructions.

example: requirements.txt or pyproject.toml, conda environment or venv, some notes in README.md would be nice.
Mainly interested in exact pytorch version, since that is usually hard to find out from just the code.
License is also missing, could you set it to whatever you think is appropriate?

Thank you

[Rohan Chacko]

This conda environment file worked for me to run the demo.

For flow-vis-torch: pip install git+https://github.com/ChristophReich1996/Optical-Flow-Visualization-PyTorch
torchcubicspline: pip install git+https://github.com/patrick-kidger/torchcubicspline.git

name: flowcam
channels:
  - conda-forge
  - defaults
dependencies:
  - _libgcc_mutex=0.1=conda_forge
  - _openmp_mutex=4.5=2_gnu
  - bzip2=1.0.8=h7f98852_4
  - ca-certificates=2023.7.22=hbcca054_0
  - ld_impl_linux-64=2.40=h41732ed_0
  - libblas=3.9.0=17_linux64_openblas
  - libcblas=3.9.0=17_linux64_openblas
  - libffi=3.4.2=h7f98852_5
  - libgcc-ng=13.1.0=he5830b7_0
  - libgfortran-ng=13.1.0=h69a702a_0
  - libgfortran5=13.1.0=h15d22d2_0
  - libgomp=13.1.0=he5830b7_0
  - liblapack=3.9.0=17_linux64_openblas
  - libnsl=2.0.0=h7f98852_0
  - libopenblas=0.3.23=pthreads_h80387f5_0
  - libsqlite=3.42.0=h2797004_0
  - libstdcxx-ng=13.1.0=hfd8a6a1_0
  - libuuid=2.38.1=h0b41bf4_0
  - libzlib=1.2.13=hd590300_5
  - ncurses=6.4=hcb278e6_0
  - numpy=1.25.1=py39h6183b62_0
  - openssl=3.1.1=hd590300_1
  - pip=23.2.1=pyhd8ed1ab_0
  - python=3.9.16=h2782a2a_0_cpython
  - python_abi=3.9=3_cp39
  - readline=8.2=h8228510_1
  - setuptools=68.0.0=pyhd8ed1ab_0
  - tk=8.6.12=h27826a3_0
  - tzdata=2023c=h71feb2d_0
  - wheel=0.41.0=pyhd8ed1ab_0
  - xz=5.2.6=h166bdaf_0
  - pip:
      - appdirs==1.4.4
      - certifi==2023.7.22
      - charset-normalizer==3.2.0
      - click==8.1.6
      - contourpy==1.1.0
      - cycler==0.11.0
      - docker-pycreds==0.4.0
      - einops==0.6.1
      - filelock==3.12.2
      - flow-vis==0.1
      - flow-vis-torch==0.1
      - fonttools==4.41.1
      - fsspec==2023.6.0
      - gitdb==4.0.10
      - gitpython==3.1.32
      - huggingface-hub==0.16.4
      - idna==3.4
      - imageio==2.31.1
      - importlib-resources==6.0.0
      - kiwisolver==1.4.4
      - kornia==0.6.12
      - matplotlib==3.7.2
      - opencv-python==4.8.0.74
      - packaging==23.1
      - pathtools==0.1.2
      - pillow==10.0.0
      - piqa==1.3.1
      - protobuf==4.23.4
      - psutil==5.9.5
      - pyparsing==3.0.9
      - python-dateutil==2.8.2
      - pyyaml==6.0.1
      - requests==2.31.0
      - safetensors==0.3.1
      - scipy==1.11.1
      - sentry-sdk==1.28.1
      - setproctitle==1.3.2
      - six==1.16.0
      - smmap==5.0.0
      - splines==0.3.0
      - timm==0.9.2
      - torch==1.13.1+cu116
      - torchcubicspline==0.0.3
      - torchvision==0.14.1+cu116
      - tqdm==4.65.0
      - typing-extensions==4.7.1
      - urllib3==2.0.4
      - wandb==0.15.7
      - zipp==3.16.2