Test setting up local development environment

[zonca]

@dchoi can you also test the instructions for developers:

https://det-lab.github.io/kaitai_struct_awkward_runtime/development/

Better if you run on cdmsdev and use VS Code remote, so you install VS Code locally on your laptop and then use the VS Code remote extension https://code.visualstudio.com/docs/remote/remote-overview to connect to cdmsdev.

[dchoi]

In the part of "run tests" I get following error:

$ make test
make: *** No rule to make target 'kaitai_struct_compiler/shared/src/main/scala/io/kaitai/struct/languages/AwkwardCompiler.scala', needed by 'kaitai_struct_compiler/jvm/target/scala-2.12/classes/io/kaitai/struct'. Stop.

am i missing a step?

dj

some info:

$ ls kaitai_struct_compiler/shared/src/main/scala/io/kaitai/struct/languages/
total 276
4 components/ 20 JavaScriptCompiler.scala 20 PythonCompiler.scala
40 CppCompiler.scala 16 LuaCompiler.scala 16 RubyCompiler.scala
24 CSharpCompiler.scala 24 NimCompiler.scala 20 RustCompiler.scala
24 GoCompiler.scala 16 PerlCompiler.scala
32 JavaCompiler.scala 20 PHPCompiler.scala

I got the following when I did "pip install -e .[test]" (redo to make sure of this step).

$ pip install -e .[test]
Obtaining file:///home/xxxx/apps/kaitai/dev/kaitai_struct_awkward_runtime
Installing build dependencies ... done
Checking if build backend supports build_editable ... done
Getting requirements to build editable ... done
Installing backend dependencies ... done
Preparing editable metadata (pyproject.toml) ... done
Requirement already satisfied: awkward>=2.6.5 in ./.env/lib/python3.13/site-packages (from awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (2.8.9)
Requirement already satisfied: importlib-resources in ./.env/lib/python3.13/site-packages (from awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (6.5.2)
Requirement already satisfied: pytest-cov>=3 in ./.env/lib/python3.13/site-packages (from awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (7.0.0)
Requirement already satisfied: pytest>=6 in ./.env/lib/python3.13/site-packages (from awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (8.4.2)
Requirement already satisfied: awkward-cpp==50 in ./.env/lib/python3.13/site-packages (from awkward>=2.6.5->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (50)
Requirement already satisfied: fsspec>=2022.11.0 in ./.env/lib/python3.13/site-packages (from awkward>=2.6.5->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (2025.9.0)
Requirement already satisfied: numpy>=1.18.0 in ./.env/lib/python3.13/site-packages (from awkward>=2.6.5->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (2.3.3)
Requirement already satisfied: packaging in ./.env/lib/python3.13/site-packages (from awkward>=2.6.5->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (25.0)
Requirement already satisfied: iniconfig>=1 in ./.env/lib/python3.13/site-packages (from pytest>=6->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (2.1.0)
Requirement already satisfied: pluggy<2,>=1.5 in ./.env/lib/python3.13/site-packages (from pytest>=6->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (1.6.0)
Requirement already satisfied: pygments>=2.7.2 in ./.env/lib/python3.13/site-packages (from pytest>=6->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (2.19.2)
Requirement already satisfied: coverage>=7.10.6 in ./.env/lib/python3.13/site-packages (from coverage[toml]>=7.10.6->pytest-cov>=3->awkward_kaitai==0.2.1.dev28+g8e1034193.d20250927) (7.10.7)
Building wheels for collected packages: awkward_kaitai
Building editable for awkward_kaitai (pyproject.toml) ... done
Created wheel for awkward_kaitai: filename=awkward_kaitai-0.2.1.dev28+g8e1034193.d20250927-py3-none-any.whl size=3262 sha256=b53e541d6e6abe81669b4782909102ffd4f42e579bfe847a0bf66dfa81b46c7c
Stored in directory: /tmp/pip-ephem-wheel-cache-ythjno6o/wheels/94/21/29/41403791b607234ffcde1cc41179e3c1a8c4a2e0d8bf9f3fc8
Successfully built awkward_kaitai
Installing collected packages: awkward_kaitai
Attempting uninstall: awkward_kaitai
Found existing installation: awkward_kaitai 0.2.1.dev28+g8e1034193.d20250927
Uninstalling awkward_kaitai-0.2.1.dev28+g8e1034193.d20250927:
Successfully uninstalled awkward_kaitai-0.2.1.dev28+g8e1034193.d20250927
Successfully installed awkward_kaitai-0.2.1.dev28+g8e1034193.d20250927

[zonca]

I cannot test now, but it is possible that you need to check out that other repository inside the folder of the first repository.
The repository of the compiler is in the same organization as the current repository

[dchoi]

$ source .env/bin/activate
(.env) xxx/kaitai_struct_awkward_runtime $ make test
make: *** No rule to make target 'kaitai_struct_compiler/shared/src/main/scala/io/kaitai/struct/languages/AwkwardCompiler.scala', needed by 'kaitai_struct_compiler/jvm/target/scala-2.12/classes/io/kaitai/struct'. Stop.
(.env) xxx/kaitai_struct_awkward_runtime $ find . -name AwkwardCompiler.scala -print
(.env) xxx/kaitai_struct_awkward_runtime $

[zonca]

inside the kaitai_struct_awkward_runtime folder, run:

git submodule init
git submodule update

[zonca]

I have improved the docs in eb8482f to avoid this issue

[dchoi]

The improved document works.

[zonca]

No, the document still had a mistake.

under "Run the tests", cloning again the compiler is wrong.
The folder is already included as a submodule so there is no need of that step.

[zonca]

@dchoi sorry I had to rebuild cdmsdev,

You will have to rebuild your environment again. can you follow the instructions at:
https://det-lab.github.io/kaitai_struct_awkward_runtime/development/

step by step and let me know if anything is not working?