Files
Castor/docs/internal-instructions.md
Michael Tu 5bf33bf8ea Update README to use Castor-models and Instructions for Internal Users (#113)
* Update instructions to use Castor-models
* Consolidate requirements.txt
* Refine README with convenience scripts
* Update internal instructions
* MP-CNN working dir minor edit
2018-05-25 18:14:10 -04:00

50 lines
2.1 KiB
Markdown

# Instructions for DSG Castor Contributors
Please follow these instructions if you are a graduate student or undergrad research assistant working with the group
in the Data Systems Lab and want to run Castor on the lab desktop GPU machine (dragon).
If you have trouble / questions with instructions on this page, ping @tuzhucheng on Slack.
## PyTorch Environment
We already have a multi-user Conda environment with PyTorch and all other dependencies installed, so you do not need to
install anything yourself. However, you can create [Conda environments](https://conda.io/docs/user-guide/tasks/manage-environments.html)
if you need to experiment with different library versions etc.
The multi-user Conda environment is located at `/anaconda3/`.
To use this multi-user environment, just add the following to your `.bashrc` or configuration file for your favourite shell.
```bash
export PATH="/anaconda3/bin:$PATH"
export LIBRARY_PATH="/usr/lib/nvidia-375"
```
Please also ensure `/usr/local/cuda-8.0/lib64` is in the `LD_LIBRARY_PATH` environment variable **if it is not already**.
If not, you should add it in the `.bashrc` similar to above.
Please re-login or re-source your shell configuration after `.bashrc` is updated for the updated environment variables
to take effect.
## Data and Pre-Trained Models
We use shared cloned versions of the Castor-data and Castor-models repositories.
Instead of making your own cloned copies, you can just create symbolic links to the shared version instead
in your own working directory to save disk space. Assuming you want to put `Castor`, `Castor-data`, and `Castor-models`
under a directory called `castorini` and you are currently in the `castorini` directory, you can enter these commands:
```bash
ln -s /Castor-data Castor-data
ln -s /Castor-models Castor-models
```
So after you clone Castor, you have a directory structure under `castorini` that looks like this:
```
.
├── Castor
├── Castor-data
└── Castor-models
```
where `Castor-data` and `Castor-models` are actually symbolic links to `/Castor-data` and `/Castor-models`.