To develop this package, you will need AtomicAndPhysicalConstants.jl
which is not yet on the official Julia registry. Therefore in the Julia REPL run:
import Pkg;
Pkg.develop(url="https://github.com/bmad-sim/AtomicAndPhysicalConstants.jl.git"); # Dependency
Pkg.develop(url="https://github.com/bmad-sim/BeamTracking.jl.git"); # This package! Replace bmad-sim with your username if working on a fork
If working on your own fork, replace bmad-sim
in the above develop
url with your Github username.
In your ~/.julia/dev/
directory, you will now see the directory BeamTracking
. This is the Github repo where you can do your work and push changes.
If you would like to add a dependency to the project (e.g. OrdinaryDiffEq.jl
), you should:
- In the
~/.julia/dev/BeamTracking.jl
directory, startjulia
- Enter package-mode using
]
, and then typeactivate .
. This activates theProject.toml
in the current directory you're in - In package-mode, type
add OrdinaryDiffEq
. This will add the package as a dependency to theProject.toml
. - In the main module
src/BeamTracking.jl
, add ausing OrdinaryDiffEq
to the top ofBeamTracking.jl
, and in your particularly module defined below add ausing ..OrdinaryDiffEq
which basically says, go one module level up and getOrdinaryDiffEq
.