# SwarmPAL Plan

For more background, see Smith ARA and Pačes M (2022) Python tools for ESA’s Swarm mission: VirES for Swarm and surrounding ecosystem. Front. Astron. Space Sci. 9:1002697. doi: [10.3389/fspas.2022.1002697](https://doi.org/10.3389/fspas.2022.1002697)

## Data access through viresclient

[](https://mermaid.live/edit#pako:eNrFUttO4zAQ_ZWRJRCIwgdUu0gsRQhptUUbqS9JHib2NDXEduRLVhXl3xkn0BateGZebM859pzjmRchnSIxF63HfgO__1YWOEJqpsQCI8KNlBTChORQ2pOM2tk9P8eqKM9W2t8VUJAfyM9_NP56aQl671SSEX6C41PUhiCQ1xQyoUhNQNN32rZwmusGipEPGbsnZ7C1FLUEwzI7oAG7hLl0xi8462kGdNVegXT2KdlRVjivD7JOTg5ujuXBJ8r7slr8Kpc9S9SBFCg232AgcGso_qE3H1ZC_d_l1W1Z3mKPje50ZG_f6L6uv7AGl5fXLPQTSlYdtzBTduM35RI3jw87GMqB-x1kp8nGo6eHkfu4jZtJT_6tuO0p7ECls3IxDgmkgC1l-I-L1Dj3PPpexg13oEf5zGioz6dX91rETBjyBrXiyXzJuUrwDUOVmPNW0RpTFytR2Vempp5L053S0XkxX2MXaCYwRVdsrdwnJtZCI4-Cec--vgElyPiL)

## SwarmPAL provides algorithms & visualisation on top of that

[](https://mermaid.live/edit#pako:eNqNU12L2zAQ_CvCD31K7mgfQwgELtDCpZi6vYfaoSjS2t5Glow-kguX--9dyY4vXPtQg409Hs3OjlYvmTASskVWK3MSLbeePX6rdKWF4s49QM1c2DeW9-2vnkuJumE1KrXQRsPMeWsOkN4rfeWxnIsDb6AsTtx2-fqR9QOwu-G8F_3ISkb_GV0SLQiPRicjEQkelSsLMgdyuber-I0ewe3YfL5i3hjlBuak_52wvXkuc2oIRVDcJhpBLPY7lopXWl2uVWMs-rZzscDX0OXn-0JgfmbgRYTi_YQucIWOR3cR2HLfK-MV7iNtFAUtRzPSTRlEtuSeM4osCB8smZ9YbHnTRlqeHmkH_pHUeyTu1tT4E9pNQT1qPYQ4FDlSpk4oBO1jZJdkK3rqrZHkx12ij7Hujdrndf7lL7GW93ijtdbn_1Bak8AxbRqBAiUcy9ya36TLTsYeUsS42jz3QBNIBFJH593yHle7qNaUW47a080-MOyo2hHGRYWpPfUDlHyDGsC-rUpRNmx-R_mOY3ktP4Bj6ATSNszvCLr80FgjSEbVwNZcwCX6iVPzqSyiMQHXGcpmWQe24yjpAL3EdKrMt9BBlS3oVULNg_JVVulXovLgTXHWIlvQDMAsCz1NBDwgp4S6bFFz5SZ0I9Ebe2VaE5p2YvRc_zTmbQUk7nY4xuk0v_4B1MpiVw)

## What is SwarmPAL?

A project to deliver a Python package called `swarmpal` which provides high level tools covering both data access and low-level analysis routines. With several toolbox development activities happening, we need to:
1. Reduce duplication of effort
2. Coordinate functionalities and presentation so that they are coherent to the users
3. Ensure that the toolboxes are well supported by the VRE & accessible in different ways
4. Address the longer-term sustainability of the toolboxes

Many of the challenges in delivering a Python package are beyond the experience of individual developer-scientists (and the best available tools change rapidly), and maintenance of that package is difficult after the funded project time has finished. We can alleviate this burden, and avoid a fragmentation of different tools and procedures among the Swarm developer community, by centralising toolbox development work into one place. The requirements and scope of each toolbox should first be analysed to see if they overlap enough with the other tools and goals of SwarmPAL - otherwise they may be better off as a separate package (e.g. [pyAMPS](https://github.com/klaundal/pyAMPS/) and [ChaosMagPy](https://github.com/ancklo/ChaosMagPy))

Current toolbox activities to consider:
- TFA
- SECS
- (FAC)
- ((MVA))

Building swarmpal:

[](https://mermaid.live/edit#pako:eNptUl1r4zAQ_CuLHg4Hmty7KYXiuDRwB6FO-2LnYSNvEl1tyUiyG9P0v9_KdtIWqgd9rGZnhpHehTQliVgcLDZH-PNUaODxkkcvyqYZZGQ7srPtVIb5_A66vFOWnKwUaT_dpHmeSuN656mOb3f2zknV9EBeLsJp3T8m2wnaBZJzSQ3pkrTsw_0vKNEj7CvzdoYlbwfoiHftbjTn3tDWJ1j3_mg0NChf8UAjJozQlocJUEpyLvD-Bjp51sFdReANGH8kC0p7sntk0PazfWNMtTMnct8ZR7Of5q6w_F5j1Ts16PhL9QthsoryDTmv9GGIYPA7HZZGtjWnh14ZHQrPDWtw-2zsZ8tTrqzPBhxVJD2VcI1NkTt_9TzC19b8Y6CLounqWgkim4f7sGRpkoWVH2c2-94H88WC5Z7IEVrJkZu959SJdTuqTEP2J9VkxX38Mf4iJxtFw0IataQL_1AaQD9wk-ZYaKBOViO-0OJG1GRrVCV_zvdQLQQ_Xk2FiHlbon0tRKE_GNcO2aWl8saKeI-VoxuBrTdZr6WIvW3pAloq5L9UT6iP__QzAMQ)