VLXI-Cookiecutter-Research

Julia Quick Reference

Authors
Kevin T. Chu <kevin@velexi.com>

Table of Contents

Julia Package Manager Commands
Making a Julia Package Importable

1. Julia Package Manager Commands

Activate Julia package manager REPL.
```
julia> ]

(...) pkg>
```
Display the list of Julia package dependencies.
```
(...) pkg> status
```
or
```
(...) pkg> st
```
Add a Julia package dependency.
```
(...) pkg> add PKG_NAME
```

Remove a Julia package dependency.

(...) pkg> remove PKG_NAME

or

(...) pkg> rm PKG_NAME

2. Making a Julia Package Importable

To make Julia code in the src directory importable using the import X syntax in Julia, the following conditions must be satisified.

Project.toml must contain the name of the Julia package/module.
```
name = "X"
```
A file named X.jl must exist in the src directory.
If /PATH/TO/PROJECT_DIR is the parent directory of the src directory, it must be included in
- the JULIA_LOAD_PATH environment variable
```
$ export JULIA_LOAD_PATH=/PATH/TO/PROJECT_DIR:$JULIA_LOAD_PATH
```
  or
- the LOAD_PATH Julia variable
```
julia> push!(LOAD_PATH, "/PATH/TO/PROJECT_DIR")
```

This site is open source. Improve this page.