Skip to content

Commit 884904f

Browse files
JoschDfsoubelet
JoschD
and
fsoubelet
authored
Add new (and old) pylhc packages (#230)
Co-authored-by: Felix Soubelet <[email protected]>
1 parent 8be58df commit 884904f

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

‎docs/packages/about.md‎

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
# The OMC Python Packages
22

3-
| Package | Description | Version | Documentation | Wiki |
4-
|-:--------------------------------------------------------|-:------------------------------------------------------------------------------------------------------------|-:-:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-:-:--------------------------------------------------------------|-:-:--------------------------------------------------------------------|
5-
| [**OMC3**][omc3]{target=\_blank} | Frequency analysis, optics computation from turn-by-turn data, corrections calculations and results plotting | [![PyPI version for OMC3](https://img.shields.io/pypi/v/omc3.svg)][omc3_pypi]{target=\_blank} | [:fontawesome-solid-book:][omc3_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](omc3/about.md) |
6-
| [**TFS-Pandas**][tfspandas]{target=\_blank} | TFS files I/O functionality | [![PyPI version for TFS-Pandas](https://img.shields.io/pypi/v/tfs-pandas.svg)][tfs_pypi]{target=\_blank} | [:fontawesome-solid-book:][tfspandas_doc]{target=\_blank} | |
7-
| [**Turn-by-Turn**][turnbyturn]{target=\_blank} | Particle accelerators turn-by-turn BPM measurements I/O functionality | [![PyPI version for Turn-by-Turn](https://img.shields.io/pypi/v/turn_by_turn.svg)][tbt_pypi]{target=\_blank} | [:fontawesome-solid-book:][turnbyturn_doc]{target=\_blank} | |
8-
| [**SDDS**][sdds]{target=\_blank} | SDDS files I/O functionality | [![PyPI version for SDDS](https://img.shields.io/pypi/v/sdds.svg)][sdds_pypi]{target=\_blank} | [:fontawesome-solid-book:][sdds_doc]{target=\_blank} | |
9-
| [**PyLHC-Tools**][pylhc]{target=\_blank} | Useful OMC-related scripts | [![PyPI version for PyLHC-Tools](https://img.shields.io/pypi/v/PyLHC.svg)][pylhc_pypi]{target=\_blank} | [:fontawesome-solid-book:][pylhc_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](pylhc/about.md) |
10-
| [**PyLHC-Submitter**][pylhc_submitter]{target=\_blank} | Wrapper for HTCondor job submission | [![PyPI version for PyLHC-Submitter](https://img.shields.io/pypi/v/pylhc-submitter.svg)][pylhc_submitter_pypi]{target=\_blank} | [:fontawesome-solid-book:][pylhc_submitter_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](pylhcsubmitter/job_submitter.md) |
11-
| [**Optics-Functions**][optics_functions]{target=\_blank} | Calculate various beam optics functions from TFS-Dataframes | [![PyPI version for Optics-Functions](https://img.shields.io/pypi/v/optics-functions.svg)][optics_functions_pypi]{target=\_blank} | [:fontawesome-solid-book:][optics_functions_doc]{target=\_blank} | |
12-
| [**Generic-Parser**][generic_parser]{target=\_blank} | Entrypoint argument parser functionality | [![PyPI version for Generic-Parser](https://img.shields.io/pypi/v/generic-parser.svg)][generic_parser_pypi]{target=\_blank} | [:fontawesome-solid-book:][generic_parser_doc]{target=\_blank} | |
13-
| [**Example Study Scripts**][mess]{target=\_blank} | Collection of example MAD-X studies | [![GitHub release for MESS](https://img.shields.io/github/v/release/pylhc/MESS?color=orange&label=Release&logo=Github)][mess_releases]{target=\_blank} | | [:fontawesome-solid-circle-question:](mess/about.md) |
14-
| [**Beta-Beat.src**][betabeatsrc]{target=\_blank} | Frequency analysis, optics computation from turn-by-turn data and corrections calculations | [![GitHub release for Beta-Beat.src](https://img.shields.io/github/v/release/pylhc/Beta-Beat.src?color=orange&label=Release&logo=Github)][betabeatsrc_releases]{target=\_blank} | [:fontawesome-solid-book:][betabeatsrc_doc]{target=\_blank} | |
3+
| Package | Description | Version | Documentation | Wiki |
4+
|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|--------------------------------------------------------------------------|
5+
| [**OMC3**][omc3]{target=\_blank} | Frequency analysis, optics computation from turn-by-turn data, corrections calculations and results plotting | [![PyPI version for OMC3](https://img.shields.io/pypi/v/omc3.svg)][omc3_pypi]{target=\_blank} | [:fontawesome-solid-book:][omc3_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](omc3/about.md) |
6+
| [**OMC3 GUI**][omc3_gui]{target=\_blank} | Graphical User Interface for OMC3 Segment-by-Segment Analysis | [![PyPI version for OMC3 GUI](https://img.shields.io/pypi/v/omc3_gui.svg)][omc3_gui_pypi]{target=\_blank} | [:fontawesome-solid-book:][omc3_gui_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](../guis/segment_by_segment/gui.md) |
7+
| [**TFS-Pandas**][tfspandas]{target=\_blank} | TFS files I/O functionality | [![PyPI version for TFS-Pandas](https://img.shields.io/pypi/v/tfs-pandas.svg)][tfs_pypi]{target=\_blank} | [:fontawesome-solid-book:][tfspandas_doc]{target=\_blank} | |
8+
| [**Turn-by-Turn**][turnbyturn]{target=\_blank} | Particle accelerators turn-by-turn BPM measurements I/O functionality | [![PyPI version for Turn-by-Turn](https://img.shields.io/pypi/v/turn_by_turn.svg)][tbt_pypi]{target=\_blank} | [:fontawesome-solid-book:][turnbyturn_doc]{target=\_blank} | |
9+
| [**SDDS**][sdds]{target=\_blank} | SDDS files I/O functionality | [![PyPI version for SDDS](https://img.shields.io/pypi/v/sdds.svg)][sdds_pypi]{target=\_blank} | [:fontawesome-solid-book:][sdds_doc]{target=\_blank} | |
10+
| [**PyLHC-Tools**][pylhc]{target=\_blank} | Useful OMC-related scripts | [![PyPI version for PyLHC-Tools](https://img.shields.io/pypi/v/PyLHC.svg)][pylhc_pypi]{target=\_blank} | [:fontawesome-solid-book:][pylhc_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](pylhc/about.md) |
11+
| [**PyLHC-Submitter**][pylhc_submitter]{target=\_blank} | Wrapper for HTCondor job submission | [![PyPI version for PyLHC-Submitter](https://img.shields.io/pypi/v/pylhc-submitter.svg)][pylhc_submitter_pypi]{target=\_blank} | [:fontawesome-solid-book:][pylhc_submitter_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](pylhcsubmitter/job_submitter.md) |
12+
| [**Optics-Functions**][optics_functions]{target=\_blank} | Calculate various beam optics functions from TFS-Dataframes | [![PyPI version for Optics-Functions](https://img.shields.io/pypi/v/optics-functions.svg)][optics_functions_pypi]{target=\_blank} | [:fontawesome-solid-book:][optics_functions_doc]{target=\_blank} | |
13+
| [**Generic-Parser**][generic_parser]{target=\_blank} | Entrypoint argument parser functionality | [![PyPI version for Generic-Parser](https://img.shields.io/pypi/v/generic-parser.svg)][generic_parser_pypi]{target=\_blank} | [:fontawesome-solid-book:][generic_parser_doc]{target=\_blank} | |
14+
| [**IRNL RDT Correction**][irnl_rdt_correction]{target=\_blank} | Calculate powering of IR NL-correctors based on RDT compensation. | [![PyPI version for IRNL RDT Correction](https://img.shields.io/pypi/v/irnl-rdt-correction.svg)][irnl_rdt_correction_pypi]{target=\_blank} | [:fontawesome-solid-book:][irnl_rdt_correction_doc]{target=\_blank} | [:fontawesome-solid-circle-question:](irnl/about.md) |
15+
| [**IR Amplitude Detuning Correction**][ir_amplitude_detuning]{target=\_blank} | Correct amplitude detuning via IR correctors. | [![PyPI version for IR Amplitude Detuning Correction](https://img.shields.io/pypi/v/ir-amplitude-detuning.svg)][ir_amplitude_detuning_pypi]{target=\_blank} | [:fontawesome-solid-book:][ir_amplitude_detuning_doc]{target=\_blank} | |
16+
| [**Example Study Scripts**][mess]{target=\_blank} | Collection of example MAD-X studies | [![GitHub release for MESS](https://img.shields.io/github/v/release/pylhc/MESS?color=orange&label=Release&logo=Github)][mess_releases]{target=\_blank} | | [:fontawesome-solid-circle-question:](mess/about.md) |
17+
| [**Beta-Beat.src**][betabeatsrc]{target=\_blank} | Frequency analysis, optics computation from turn-by-turn data and corrections calculations | [![GitHub release for Beta-Beat.src](https://img.shields.io/github/v/release/pylhc/Beta-Beat.src?color=orange&label=Release&logo=Github)][betabeatsrc_releases]{target=\_blank} | [:fontawesome-solid-book:][betabeatsrc_doc]{target=\_blank} | |
18+
| [**Accelerator Timeline**][betabeatsrc]{target=\_blank} | Frequency analysis, optics computation from turn-by-turn data and corrections calculations | [![GitHub release for Beta-Beat.src](https://img.shields.io/github/v/release/pylhc/Beta-Beat.src?color=orange&label=Release&logo=Github)][betabeatsrc_releases]{target=\_blank} | [:fontawesome-solid-book:][betabeatsrc_doc]{target=\_blank} | |
1519

1620
## The OMC Python Ecosystem
1721

@@ -56,9 +60,18 @@ The environment is located at `/afs/cern.ch/eng/sl/lintrack/omc_python3/` and ca
5660
[generic_parser_pypi]: https://pypi.org/project/generic-parser/
5761
[mess]: https://github.com/pylhc/MESS
5862
[mess_releases]: https://github.com/pylhc/MESS/releases
63+
[irnl_rdt_correction]: https://github.com/pylhc/irnl_rdt_correction
64+
[irnl_rdt_correction_doc]: https://pylhc.github.io/irnl_rdt_correction
65+
[irnl_rdt_correction_pypi]: https://pypi.org/project/irnl_rdt_correction/
66+
[ir_amplitude_detuning]: https://github.com/pylhc/ir_amplitude_detuning
67+
[ir_amplitude_detuning_doc]: https://pylhc.github.io/ir_amplitude_detuning
68+
[ir_amplitude_detuning_pypi]: https://pypi.org/project/ir_amplitude_detuning/
5969
[omc3]: https://github.com/pylhc/omc3
6070
[omc3_doc]: https://pylhc.github.io/omc3
6171
[omc3_pypi]: https://pypi.org/project/omc3/
72+
[omc3_gui]: https://github.com/pylhc/omc3_gui
73+
[omc3_gui_doc]: https://pylhc.github.io/omc3_gui
74+
[omc3_gui_pypi]: https://pypi.org/project/omc3_gui/
6275
[optics_functions]: https://github.com/pylhc/optics_functions
6376
[optics_functions_doc]: https://pylhc.github.io/optics_functions
6477
[optics_functions_pypi]: https://pypi.org/project/optics-functions/

0 commit comments

Comments
 (0)