jwreep/hissw

Integrate SSW into your Python workflows

🐍 ☀️ hiss(w)

Easily integrate SSWIDL into your Python workflows. See the docs for more info.

Install

To install hissw,

$ pip install hissw

which will automatically install the package and its dependencies. hissw depends on the Jinja2 and scipy libraries. You can also install these manually with conda or from PyPI, i.e. pip install <package-name>. Additionally, you'll need a local install of IDL and the Solarsoft library.

Alternatively, you can install hissw from GitHub,

$ git clone https://github.com/wtbarnes/hissw.git
$ cd hissw && python -m pip install -e[all,test]

and then run the tests to make sure everything is working alright. Note that you must specify paths to SSW and IDL appropriately.

$ pytest --ssw-home=<path to top of SSW tree> --idl-home=<path to top level dir of IDL install>

Note: hissw relies on executing several shell commands. This has not been tested on Windows.

Citing hissw

If you use hissw in your work, please use the following citation,

@software{will_barnes_2022_6640421,
  author       = {Will Barnes and
                  Bin Chen},
  title        = {wtbarnes/hissw: v2.0},
  month        = jun,
  year         = 2022,
  publisher    = {Zenodo},
  version      = {v2.0},
  doi          = {10.5281/zenodo.6640421},
  url          = {https://doi.org/10.5281/zenodo.6640421}
}

Reporting Issues and Contributing

Open an issue on GitHub to report a problem. Pull requests welcome.