If you would like to modify UTK's core code and/or make contributions, you won't be able to use the utk command (since it points to the utk pip installation). Alternatively, you will have to:
- Clone the repository with
git clone git@github.com:urban-toolkit/utk.git. - Install Node.js, either using conda, package managers, or pre-built installers.
- Build the utk-ts bundle. Inside
src/utk-ts, you should run the following in the terminal:npm install && npm run build. After that, a bundle will be created. - Build the utk-frontend bundle. Inside
src/utk-frontend, you should run the following in the terminal:npm install && npm run build:web. After that, another bundle will be created. - Run the UTK server. Inside the
src, run the following in the terminal:python utk_server.py start --bundle utk-frontend/build/utk-app/, and with the other appropriate arguments (e.g.,--datawith the path to your data folder).
To automatically build the bundles (steps 2 and 3) when you make changes to the source code, you can run utk_server.py with the --watch argument.
The following documents pertain to the Curio project but are also relevant to UTK: