Metadata-Version: 2.4
Name: fastshermanmorrison-pulsar
Version: 0.5.5
Summary: The Enterprise add-on FastShermanMorrison for optimized EcorrKernel calculations
Home-page: http://github.com/nanograv/fastshermanmorrison/
Author: Rutger van Haasteren
Author-email: Rutger van Haasteren <rutger@vhaasteren.com>
License: MIT License
        
        Copyright (c) 2023 Rutger van Haasteren
        
        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.
        
Project-URL: Homepage, https://github.com/nanograv/fastshermanmorrison
Project-URL: Bug Tracker, https://github.com/nanograv/fastshermanmorrison/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# FastShermanMorrison

![PyPI](https://img.shields.io/pypi/v/fastshermanmorrison-pulsar)
![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/fastshermanmorrison-pulsar)


Cython code to more quickly evaluate ShermanMorrison combinations as need by
kernel ecorr in Enterprise.

# Installation

The FastShermanMorrison add-on to Enterprise can be easily installed straight
from github using

```bash
pip install git+https://github.com/nanograv/fastshermanmorrison.git
```

From Pypi, you can do

```bash
pip install fastshermanmorrison-pulsar
```

Conda support is in testing stage. Apple silicon arm processors are not supported yet, but on other architectures you can do

```
conda install -c vhaasteren fastshermanmorrison-pulsar
```

Availability on conda-forge is upcoming in a later release

## Citation

If you use `fastshermanmorrison-pulsar` in your research, please cite it as follows:

### BibTeX Entry
```bibtex
@software{fastshermanmorrison-pulsar,
  author       = {Rutger van Haasteren},
  title        = {fastshermanmorrison-pulsar: Fast Sherman-Morrison Updates for Pulsar Timing},
  year         = {2023},
  version      = {0.5.4},
  publisher    = {GitHub},
  url          = {https://github.com/nanograv/fastshermanmorrison},
  doi          = {10.5281/zenodo.17439723},
  note         = {Software for efficient Sherman-Morrison matrix updates in pulsar timing analysis}
}
```

### Text Citation
van Haasteren, R. (2023). fastshermanmorrison-pulsar: Fast Sherman-Morrison Updates for Pulsar Timing (Version 0.5.4) [Software]. GitHub. https://github.com/nanograv/fastshermanmorrison

