Skip to content

About

Documentation for ACE3P (Advanced Computational Electromagnetic 3D Parallel) simulation suite

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

48 Commits

Folders and files

Repository files navigation

ACE3P Documentation

User documentation for ACE3P, SLAC's parallel finite-element electromagnetic simulation suite: getting started on S3DF and NERSC Perlmutter, the simulation workflow, per-module user guides and tutorials, and input-keyword reference tables generated from the ACE3P source.

Published site: https://slaclab.github.io/ace3p-docs/

Built with MkDocs and the Material theme. Versioned with mike so each ACE3P release has matching documentation.

Build locally

pip install -r requirements.txt
mkdocs serve            # live preview at http://127.0.0.1:8000
mkdocs build --strict   # what CI runs

Regenerate the keyword reference

python tools/extract_keywords.py /path/to/ace3p --out docs/reference

Contributing

See docs/contributing.md. Issues and pull requests are welcome. The main branch is protected; changes land through pull requests.

Origin

This site supersedes the CW23 workshop slide decks previously distributed as PDFs on SLAC Confluence.

Copyright SLAC National Accelerator Laboratory. The documentation text and images are licensed under CC BY 4.0. ACE3P itself is not part of this repository and is distributed under its own terms.

About

Documentation for ACE3P (Advanced Computational Electromagnetic 3D Parallel) simulation suite

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages