Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: import deprecated projects from PWA Pages #60

Merged
merged 3 commits into from
Sep 20, 2021
Merged

docs: import deprecated projects from PWA Pages #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dba84cb
docs: list deprecated ComPWA projects
redeboer Sep 20, 2021
89aa4d7
fix: refer to ComPWA main projects
redeboer Sep 20, 2021
9943d82
fix: update links to PWA Pages
redeboer Sep 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,29 @@ Finally, the {doc}`technical reports </reports>` on these pages
tips and tricks, some of which can be of interest to general Python users as
well!

:::{dropdown} Deprecated projects

The main packages listed above originate from the following, deprecated
projects:

<!-- cspell:ignore pycompwa -->

- {doc}`ComPWA <ComPWA:index>`: a single framework for Partial Wave Analysis
written in C++.
- {doc}`pycompwa <pycompwa:index>`: the Python interface of ComPWA, which also
hosted a first version of the PWA Expert System.
- {doc}`PWA Expert System <expertsystem:index>` (split into
{doc}`QRules <qrules:index>` and {doc}`AmpForm <ampform:index>`).

:::

## Long-term development

Partial Wave Analysis is a complicated research discipline, where several
aspects of quantum field theory, experimental physics, statistics, regression
analysis, and high-performance computing come together. This has led to
{ref}`a large number of PWA frameworks <software:Other recommendations>` that
taylor to the need of each collaboration.
{ref}`a large number of PWA frameworks <pwa:software:Inventory of PWA projects>`
that taylor to the need of each collaboration.

This state of affairs is only natural: research requires a flexible and
specialized approach. If, say, some background component shows up in an ongoing
Expand Down
12 changes: 6 additions & 6 deletions docs/develop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ administrator rights, see instructions on
[this page](https://www.anaconda.com/distribution). In addition, Conda can
install more than just Python packages.

All projects
{ref}`affiliated with the PWA pages <software:Affiliated projects>` provide a
All packages {ref}`maintained by the ComPWA organization <about:Main projects>`
provide a
[Conda environment file](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
([`environment.yml`](https://github.com/ComPWA/ampform/blob/main/environment.yml))
that defines the minimal dependencies to run the framework. To create an
Expand Down Expand Up @@ -607,10 +607,10 @@ Publicly available are:
### Branching model

While our aim is to maintain long-term, stable projects,
{ref}`PWA software projects <software:Affiliated projects>` are academic
projects that are subject to change and often require swift modifications or
new features for ongoing analyses. For this reason, we work in different layers
of development. These layers are represented by Git branches.
{ref}`PWA software projects <pwa:software:Inventory of PWA projects>` are
academic projects that are subject to change and often require swift
modifications or new features for ongoing analyses. For this reason, we work in
different layers of development. These layers are represented by Git branches.

![Epic branches](./_static/epic-branches.svg)

Expand Down