Welcome to CAMML codes

This is our repository that groups together the various codes developed in the CAMML group.

Getting started

This repo uses git submodules the track various codes which each live in their own repository. We do this using their https:// versions which means you are asked for your credentials every time you want to access them. To avoid this you can run the following command which will use your git credentials instead:

# Run this command once to tell Git: 
# "Any time you see an HTTPS URL for github.com, use the SSH URL instead."
git config --global url."git@github.com:".insteadOf "https://github.com/"

To clone the repository use

git clone https://github.com/camml-lab/camml-codes.git
cd camml-codes
chmod +x codes

to initialise the codes (submodules), use

./codes init

then, to pip install all the codes use

./codes install

otherwise, if you prefer to manually install one or more of the codes you can do so using pip install -Ue <dir>.

Development

This part contains instructions for anyone maintaining this package.

To update the submodules to the latest versions on the development branch, use:

./codes update

[WARNING] This will rebase onto the current versions of the submodules, so they should ideally be in a clean state.

If there are any updates, then these will now show up in git status which can be committed and pushed.