Skip to content

Commit

Permalink
Merge pull request #66 from jzuhone/jzuhone-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jzuhone authored Oct 24, 2024
2 parents 5dc85f3 + c7016d9 commit 71e3331
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![yt](http://img.shields.io/badge/powered%20by-yt-blue.svg?style=flat)](http://yt-project.org/) [![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
[![yt](http://img.shields.io/badge/powered%20by-yt-blue.svg?style=flat)](https://yt-project.org/) [![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](https://www.astropy.org/)
[![Build Status](https://travis-ci.org/jzuhone/pyxsim.svg?branch=master)](https://travis-ci.org/jzuhone/pyxsim)
[![Coverage Status](https://coveralls.io/repos/github/jzuhone/pyxsim/badge.svg?branch=master)](https://coveralls.io/github/jzuhone/pyxsim?branch=master)

# What is pyXSIM?

pyXSIM is a Python package for simulating X-ray observations from astrophysical sources.
Expand All @@ -17,19 +17,19 @@ observatories.

# The Heritage of pyXSIM

pyXSIM is an implementation of the [PHOX](http://www.mpa-garching.mpg.de/~kdolag/Phox/)
pyXSIM is an implementation of the [PHOX](https://adlibitum.oats.inaf.it/veronica.biffi/phox.html)
algorithm, developed for constructing mock X-ray observations from SPH datasets by
Veronica Biffi and Klaus Dolag. There are two relevant papers:

[Biffi, V., Dolag, K., Bohringer, H., & Lemson, G. 2012, MNRAS, 420, 3545](http://adsabs.harvard.edu/abs/2012MNRAS.420.3545B)
[Biffi, V., Dolag, K., Bohringer, H., & Lemson, G. 2012, MNRAS, 420, 3545](https://ui.adsabs.harvard.edu/abs/2012MNRAS.420.3545B)

[Biffi, V., Dolag, K., Bohringer, H. 2013, MNRAS, 428, 1395](http://adsabs.harvard.edu/abs/2013MNRAS.428.1395B)
[Biffi, V., Dolag, K., Bohringer, H. 2013, MNRAS, 428, 1395](https://ui.adsabs.harvard.edu/abs/2013MNRAS.428.1395B)

pyXSIM had a previous life as the `photon_simulator` analysis module as a part of the
[yt Project](http://yt-project.org). pyXSIM still depends critically on yt to provide the
[yt Project](https://yt-project.org). pyXSIM still depends critically on yt to provide the
link between the simulation data and the algorithm for generating the X-ray photons. For
detailed information about the design of the algorithm in yt, check out
[the SciPy 2014 Proceedings](http://conference.scipy.org/proceedings/scipy2014/zuhone.html).
[the SciPy 2014 Proceedings](https://proceedings.scipy.org/articles/Majora-14bd3278-010).

# Installing pyXSIM

Expand All @@ -47,7 +47,7 @@ install them, if they are not already installed in your Python distribution:
[~]$ pip install pyxsim
```

Alternatively, to install into your Python distribution from [source](http://github.com/jzuhone/pyxsim):
Alternatively, to install into your Python distribution from [source](https://github.com/jzuhone/pyxsim):

```
[~]$ python setup.py install
Expand All @@ -63,16 +63,16 @@ Documentation for pyXSIM lives at http://hea-www.cfa.harvard.edu/~jzuhone/pyxsim

## Mailing List

There's a [pyXSIM Google Group](https://groups.google.com/forum/#!forum/pyxsim) to get help and
There's a [Google Group](https://groups.google.com/g/soxs-pyxsim-sims) to get help with pyXSIM and
discuss related matters.

## GitHub Issues Page

If you have a specific code issue that seems like a bug or have a feature or enhancement request,
the best place to note it is on the [GitHub issues page](http://github.com/jzuhone/pyxsim/issues)
the best place to note it is on the [GitHub issues page](https://github.com/jzuhone/pyxsim/issues)
so that we can keep track of it.

## Slack Channel at the yt Project

The yt Project has a [Slack](http://www.slack.com) team which has a pyXSIM channel. Sign up for
the [yt Slack team](http://yt-project.slack.com) to get onto the channel and ask questions.
The yt Project has a [Slack](https://www.slack.com) team which has a pyXSIM channel. Sign up for
the [yt Slack team](https://yt-project.slack.com) to get onto the channel and ask questions.

0 comments on commit 71e3331

Please sign in to comment.