Skip to main content

PyTao

PyTao is Python interface for Tao, which is based on the Bmad subroutine library for relativistic charged–particle and X-ray simulations in accelerators and storage rings.

Documentation
Documentation
Documentation

Installation

See the PyTao installation instructions for details. The preferred installation method is using conda, which includes everything you need to run PyTao (including Bmad itself):

conda install -c conda-forge pytao

Current Build status and Release Info

Name Downloads Version Platforms
Conda Recipe Conda Downloads Conda Version Conda Platforms

Resources

Bmad website Bmad source code

Quickstart

Start a quick PyTao session with IPython using:

$ pytao -init tao.init
----------------------------------------------------------
Initializing Tao object with the following: -init tao.init
Type`tao.` and hit tab to see available commands.
----------------------------------------------------------

In [1]: tao
Out[1]: <Tao init='-init tao.init' so_lib='/path/to/libtao.so'>

To use PyTao's plotting with Matplotlib ("mpl", alternatively Bokeh "bokeh"), use the --pyplot argument.

$ pytao --pyplot=mpl -init "$ACC_ROOT_DIR/bmad-doc/tao_examples/cbeta_cell/tao.init"
------------------------------------------------------------------------------------------------------
Initializing Tao object with: -init /Users/klauer/Repos/bmad/bmad-doc/tao_examples/cbeta_cell/tao.init

Type `tao.` and hit tab to see available commands.
------------------------------------------------------------------------------------------------------

* Matplotlib mode configured. Pyplot available as `plt`. *

Logging

PyTao stays quiet by default. To see its log output, call pytao.configure_logging:

import pytao

pytao.configure_logging(level="DEBUG")

On the command line, use --pylog (e.g. pytao --pylog DEBUG -init tao.init). See the logging documentation for the full details, including writing to a file and controlling how Tao's own message levels map to Python logging.

For developers: the release process

To release a new PyTao version with updated bindings for the Fortran functions:

  1. Activate a conda environment with bmad installed with the target version
  2. Double-check that bmad is updated in the environment via conda list |grep bmad
  3. Run bash scripts/bump_minimum_version.sh
  4. Commit, push, merge PR, tag, ...

License

GNU General Public License

Metadata

Release files for pytao 1.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytao 1.3.3
File Size Uploaded Provenance
pytao-1.3.3.tar.gz 394.7 kB Without provenance Details

Release files / pytao-1.3.3.tar.gz

Download URL pytao-1.3.3.tar.gz
Size 394.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a9bf309805af1487d045de6ba372a150b9c1b650138719a49f0c77168de87e85
BLAKE2b-256 checksum
How to use checksums
1c303ea9ca5e068674d28d068812b5828edc41a9d86d01fcc0ea33e18a4b8e36
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for pytao 1.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.3.3 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page