Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattsignorelli authored Nov 29, 2023
1 parent 196df06 commit a54a8d0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Tao.jl
Interface to the Tao program (from the Bmad ecosystem) for simulating high energy charged particle beams and X-rays.
Interface to the Tao program (from the Bmad ecosystem) for simulating high energy charged particle beams and X-rays. This package presently provides Julia functions for various polarization calculations that interface to Tao, using the methods detailed below. Metadata is stored in .tao.jl directory, created in the user's home directory.

## Command line interface to Tao
There are currently two ways of running Tao from a Julia program. The first, and recommended way, is to have the program create a separate Tao command file (e.g. `tao.cmd`), which is then fed into Tao in the command line interface. For example, in the Julia program:
Expand Down

0 comments on commit a54a8d0

Please sign in to comment.