From 8b4594f38c65acb178ffcd854ba804c7377577f7 Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Fri, 30 Aug 2024 12:08:44 -0700 Subject: [PATCH] Doc: Intro Update Updated the intro paragraphs with ideas we discussed in the weekly meeting. --- docs/source/index.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 6ab1b75e0..904ff98d9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,23 +3,32 @@ ImpactX ------- -ImpactX is an s-based beam dynamics code including space charge effects. +ImpactX provides high-performance modeling of beam dynamics in particle accelerators with collective effects. + This is the next generation of the `IMPACT-Z `__ code. +ImpactX is runs on modern GPUs or CPUs alike, provides user-friendly interfaces suitable for AI/ML workflows, has many :ref:`benchmarks ` to ensure its correctness, and an extensive documentation. + +As a beam dynamics code, ImpactX uses the reference trajectory :math:`s` as the independent variable of motion to achieve large speedups. +See our :ref:`theory chapter ` for details on our models, assumptions and concepts. + +ImpactX is part of the `Beam, Plasma & Accelerator Simulation Toolkit (BLAST) `__. +If you are looking for a general particle-in-cell code on GPUs and CPUs, take a look at our *time-integrating* code `WarpX `__. +If you are looking for a specialized code for efficient *plasma wakefield* modeling on GPUs and CPUs, take a look at our quasi-static code `HiPACE++ `__. -Please contact us with any questions on it or if you like to contribute to its development. .. _contact: Contact us ^^^^^^^^^^ -If you are starting using ImpactX, or if you have a user question, please pop in our `discussions page `__ and get in touch with the community. +We organize support as an open community, helping each other. -The `ImpactX GitHub repo `__ is the main communication platform. +The `ImpactX GitHub repository `__ is our open communication platform. Have a look at the action icons on the top right of the web page: feel free to watch the repo if you want to receive updates, or to star the repo to support the project. For bug reports or to request new features, you can also open a new `issue `__. -We also have a `discussion page `__ on which you can find already answered questions, add new questions, get help with installation procedures, discuss ideas or share comments. +If you are starting to use ImpactX and have questions not answered by this documentation, have a look on our `discussion page `__. +There, you can find already answered questions, add your own, get help with installation procedures, help others and share ideas. .. raw:: html