Skip to content

Installation

Andrew Tritt edited this page Mar 8, 2024 · 3 revisions

The easiest way to install the code in this package is using pip. If you are using Python, the pip command should be available to you on the command line.

Interactive visualization

If you simply want to use the interactive visualizer or crop images, the simplest way to do that will be with the following command:

pip install git+https://github.com/lbl-cbg/[email protected]

Other uses

This repository follows PEP 517 style packaging, so there are many ways to install the software.

Contributing

The command above shows you how to install straight from the Git repository without the additional step of downloading code. You may want to have a easily accessible copy of the code locally so you can modify code and maybe contribute back. Start by checking out the code with git, and then installing the code with pip.

git clone [email protected]:lbl-cbg/lmcontrol.git
cd lmcontrol
pip install -e .

The -e flag provided to pip installs the code code in editable mode. Any changes you make to your local copy of the code will be reflected when you run that code.

Clone this wiki locally