wsaplus


Namewsaplus JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryWSA+: generate solar wind speed maps from synoptic magnetograms
upload_time2025-08-18 23:29:53
maintainerNone
docs_urlNone
authorPrateek Mayank, Enrico Camporeale
requires_python>=3.8
licenseMIT License Copyright (c) 2025 Prateek Mayank Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords solar wind pfss sunpy astropy pfsspy wsa deep learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # wsaplus

Generate **WSA+** solar wind speed maps at **0.1 AU** from synoptic magnetograms.

- **Input**: FITS magnetogram (GONG or HMI)
- **Output**: 2D speed map (km/s) on a 360x180 grid (phi x theta)

---

## Install

**From PyPI** (recommended):
```bash
pip install wsaplus
```

---

## Model Checkpoint (Zenodo)

The **WSA+ model checkpoint** (wsaplus.pt) is hosted on Zenodo:
**DOI**: https://doi.org/10.5281/zenodo.16883042

Download wsaplus.pt and pass it via --checkpoint, or set the WSAPLUS_CHECKPOINT environment variable.

---

## Usage

Python:

```python
from wsaplus import generate_wsaplus_map
res = generate_wsaplus_map("/path/to/GONG_2065.fits", mag_type="GONG", checkpoint_path="/path/to/wsaplus.pt")
print(res.speed_kms.shape)  # (360, 180)
```

---

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wsaplus",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "solar wind, PFSS, sunpy, astropy, pfsspy, WSA, deep learning",
    "author": "Prateek Mayank, Enrico Camporeale",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/9f/cc/bc8089456aa2045ae7fcee6216d8d8bed928cab8be95265e49d7f3423b1d/wsaplus-0.1.1.tar.gz",
    "platform": null,
    "description": "# wsaplus\n\nGenerate **WSA+** solar wind speed maps at **0.1 AU** from synoptic magnetograms.\n\n- **Input**: FITS magnetogram (GONG or HMI)\n- **Output**: 2D speed map (km/s) on a 360x180 grid (phi x theta)\n\n---\n\n## Install\n\n**From PyPI** (recommended):\n```bash\npip install wsaplus\n```\n\n---\n\n## Model Checkpoint (Zenodo)\n\nThe **WSA+ model checkpoint** (wsaplus.pt) is hosted on Zenodo:\n**DOI**: https://doi.org/10.5281/zenodo.16883042\n\nDownload wsaplus.pt and pass it via --checkpoint, or set the WSAPLUS_CHECKPOINT environment variable.\n\n---\n\n## Usage\n\nPython:\n\n```python\nfrom wsaplus import generate_wsaplus_map\nres = generate_wsaplus_map(\"/path/to/GONG_2065.fits\", mag_type=\"GONG\", checkpoint_path=\"/path/to/wsaplus.pt\")\nprint(res.speed_kms.shape)  # (360, 180)\n```\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Prateek Mayank\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "WSA+: generate solar wind speed maps from synoptic magnetograms",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/PrateekMayank/wsaplus_pythonpackage",
        "Issues": "https://github.com/PrateekMayank/wsaplus_pythonpackage/issues",
        "Source": "https://github.com/PrateekMayank/wsaplus_pythonpackage",
        "Zenodo": "https://doi.org/10.5281/zenodo.16883042"
    },
    "split_keywords": [
        "solar wind",
        " pfss",
        " sunpy",
        " astropy",
        " pfsspy",
        " wsa",
        " deep learning"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "71f3409cad342a9f4d31ac943975ded9e9586af632116f0a9c89c7b204115078",
                "md5": "53ee7ffca8c7ec17da7a15e97d4d5e8f",
                "sha256": "b74df5fca20a8f9606793c28b21ff26a2ad7aafebc389c3b68854966b86630c3"
            },
            "downloads": -1,
            "filename": "wsaplus-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "53ee7ffca8c7ec17da7a15e97d4d5e8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9994,
            "upload_time": "2025-08-18T23:29:52",
            "upload_time_iso_8601": "2025-08-18T23:29:52.498623Z",
            "url": "https://files.pythonhosted.org/packages/71/f3/409cad342a9f4d31ac943975ded9e9586af632116f0a9c89c7b204115078/wsaplus-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9fccbc8089456aa2045ae7fcee6216d8d8bed928cab8be95265e49d7f3423b1d",
                "md5": "24ed00e122f71e38455dad28b5d4fee9",
                "sha256": "5394b0a637b724ad2ac161edf2d95e552d2703544b6f16165058f7319e06de10"
            },
            "downloads": -1,
            "filename": "wsaplus-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "24ed00e122f71e38455dad28b5d4fee9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 9968,
            "upload_time": "2025-08-18T23:29:53",
            "upload_time_iso_8601": "2025-08-18T23:29:53.906650Z",
            "url": "https://files.pythonhosted.org/packages/9f/cc/bc8089456aa2045ae7fcee6216d8d8bed928cab8be95265e49d7f3423b1d/wsaplus-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-18 23:29:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PrateekMayank",
    "github_project": "wsaplus_pythonpackage",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "wsaplus"
}
        
Elapsed time: 1.08218s