Multiscope

Installation

Instructions to install Multiscope from git-on-borg and gerrit.

Getting the code

Open a terminal on the desktop and navigate to the directory where the multiscope directory should be created. Clone the git repository:

git clone https://github.com/deepmind/multiscope.git && (cd multiscope && hookdir=`git rev-parse --git-dir`/hooks ;  mkdir -p  $hookdir ; ln -s ../../.pre-commit.git $hookdir/pre-commit && chmod +x $hookdir/pre-commit)

Getting the Tools for Building and Running

Ensure you have a Go compiler whose version is >= 1.19.

go version

If you need to install a new version, it might not be consistent with your default operating system install. It may be installed in a separate location. Modify your environment variables to point to this toolchain as necessary in your shell startup configurations. e.g.

Install the protobuf compiler.

Linux:

sudo apt install -y protobuf-compiler

Mac OS:

brew install protobuf

Get the Go plugins for the protobuf compiler and update the PATH so they can be found.

go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]
export PATH="$PATH:$(go env GOPATH)/bin"

Note that the last line only adds Go to the PATH in the current terminal session. To add it permanently, add the same line to your terminal program's configuration file.

Compile the web assembly code

cd multiscope
go generate generate.go

Example Run

Navigate to one of the examples and run it.

cd clients/go/examples/
go run double/double.go --local=false

Only use --local=false to open the HTTP port to other computers (not safe on a public network for example).

Open the right port on the desktop in chrome to see the UI of multiscope. It will look like this:

Clients

Multiscope provides clients in multiple languages. Current Go, C++ and Python are under development. See the appropriate directories under clients/ for more, language specific details.

Development

Pre-commit hook

You will need to install the following executables for the pre-commit hook to work:

go install golang.org/x/tools/cmd/goimports@latest
go install github.com/golangci/golangci-lint/cmd/[email protected]

You can test the pre-commit hook by running:

zsh .pre-commit.git

from multiscope top folder.

To push commits to the main repository:

git push origin HEAD:refs/for/main

Generating the protocol buffer in Go

Run the following command from the top:

go generate protos/generate.go

Troubleshooting

Encountered problems and their solutions:

1. goimports not found, or "Please install goimports" message: you likely don't have Go in your PATH. See above how to set it.

Disclaimer

This is not an official Google Deepmind product (experimental or otherwise), it is just code that happens to be owned by Google Deepmind. Multiscope is experimental and is work in progress for the foreseeable future. It is only maintained on a best effort basis. You are welcome to send PR or to report bugs but there is no guarantee that you will get a response.