Working with the Pipeline in a Virtual Environment

Creating a VENV

In order to work on the pipeline, you must now use a virtual environment, which helps you use your own private copy of the pipeline instead of the global one installed on starmaker. Run commands 1-9 to create a venv, and command 3 every time you start working.

<venv> is the file path to where you want to install the pipeline and work in.

You may have to replace python3.9 with python and pip with pip3 depending on how your programs are installed.

1. python3.9 -m venv <venv>, which should populate the directory with a bunch of files.
2. cd <venv>
3. source ./bin/activate
4. pip3 install --upgrade pip
5. git clone https://github.com/ucsbdeepspace/tripp_pipeline
6. pip install --editable $VIRTUAL_ENV/tripp_pipeline
7. cp $VIRTUAL_ENV/tripp_pipeline/tripp/ois.py $VIRTUAL_ENV/lib/python3.9/site-packages/
8. If you see any errors, run the commands the errors suggest and retry the previous command until things work. Also, try the pyFFTW workaround.
9. which tripp should show now show your local copy, you're good to go!

One quick copy and paste:

python3.9 -m venv ./tripp
cd ./tripp
source ./bin/activate
pip3 install --upgrade pip
git clone https://github.com/ucsbdeepspace/tripp_pipeline
pip3 install --editable ./tripp_pipeline
cp ./tripp_pipeline/tripp/ois.py ./lib/python3.9/site-packages/
pip install numba==0.53.1
pip install numpy==1.19.5

#Activating a VENV To reactivate your VENV after installing, you'll need to repeat steps 2 and 3, namely,

1. cd <venv>
2. source ./bin/activate

Git Commands

After following the approve procedure, you are ready to use git commands to effectively collaborate. Note all of these commands should be ran in your git directory the /path/to/working/dir above.

Switching Between Branches

1. Git checkout -b <NAME>, creates a new branch with the given name
2. Git branch, lists the branches available (This can also be used to delete or create branches with some arguments).
3. Git checkout <NAME>, switches to the name given as long as its one of the options from git branch (branches you have)

Pushing changes

1. Git add <path to file(s) changed>
2. Git commit
3. Git push

PyFFTW Workaround

Due to an issue with sfft, it does not accept pyFFTW version 13.1. To fix this,

1. cd <venv>
2. git clone https://github.com/thomasvrussell/sfft
3. cd sfft
4. vim setup.py
5. change the Change line 24: pyFFTW 12.0 to pyFFTW so it reads pyfftw
6. Retry to install the tripp pipeline