Skip to content

Commit

Permalink
Updated docs to match v0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
aphearin committed Jan 29, 2020
1 parent 33b7cd0 commit 1ea556e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 16 deletions.
10 changes: 3 additions & 7 deletions README.md
Expand Up @@ -105,23 +105,19 @@ Although the *sim_manager* provides an object-oriented framework for creating a

[![Coverage Status](https://coveralls.io/repos/astropy/halotools/badge.svg?branch=master&service=github)](https://coveralls.io/github/astropy/halotools?branch=master)

Halotools is a fully open-source package with contributing scientists spread across many universities. The latest stable release of the package, v0.5, is now available on pip. You can also install the development version of the package by cloning the master branch on GitHub and locally building the source code, as described in the installation instructions.
Halotools is a fully open-source package with contributing scientists spread across many universities. The latest stable release of the package, v0.7, is now available on pip and conda-forge. You can also install the development version of the package by cloning the master branch on GitHub and locally building the source code, as described in the installation instructions.

---

## Asking questions and staying up-to-date

If you would like to receive notifications of new code releases, sign up for the google group

https://groups.google.com/forum/#!forum/halotools

The google group also serves as a public forum for asking questions about the code. You are also welcome to contact Andrew Hearin directly by email at ahearin@anl.gov, or by tagging @aphearin on GitHub.
You can contact Andrew Hearin directly by email at ahearin@anl.gov, or by tagging @aphearin on GitHub.

---

## Citing Halotools

If you use Halotools modules to support your science publication, we ask that you cite the code-release paper, http://arxiv.org/abs/1606.04106 paper, as well as the DOI of the version of the code you used, e.g., 10.5281/zenodo.835894 for v0.6, the current latest release. Depending on what modules you use, other citations may also be appropriate; see the *License and Citation Information* section of http://halotools.readthedocs.io for further information about how to properly cite Halotools and its supporting science and software.
If you use Halotools modules to support your science publication, we ask that you cite the code-release paper, http://arxiv.org/abs/1606.04106 paper, ideally taking note of the version of the code you used, e.g., v0.7. Depending on what modules you use, other citations may also be appropriate; see the *License and Citation Information* section of http://halotools.readthedocs.io for further information about how to properly cite Halotools and its supporting science and software.


---
Expand Down
12 changes: 3 additions & 9 deletions docs/quickstart_and_tutorials/development/citing_halotools.rst
Expand Up @@ -9,28 +9,22 @@ License and Citation Information
Citing Halotools
------------------

The first "official" release of Halotools (v0.2) was accompanied with a code-release paper, http://arxiv.org/abs/1606.04106. If you use Halotools modules to support your science publication,
we ask that you cite this paper in your work, as well as the DOI of the version of the code you used, e.g., DOI 10.5281/zenodo.835894 for v0.5, the current latest release.
The first release of Halotools (v0.2) was accompanied with a code-release paper, http://arxiv.org/abs/1606.04106. If you use Halotools modules to support your science publication,
we ask that you cite this paper in your work, ideally taking note of the version of the code you used, e.g., v0.7.

Depending on what you use Halotools to do, there may be additional citations that are appropriate.
For example, if you use a model in the `~halotools.empirical_models` sub-package
and/or a simulation in the `~halotools.sim_manager` sub-package that has
a ``publications`` attribute, each of the papers in that list should be cited.

Because Halotools is a large package
with modular functionality, it will promote reproducibility of your results
if you explicitly state in your paper which features of the code you used,
and which version of the package you used. If you used one of the Halotools-provided catalogs,
be sure to explicitly declare which catalog, including its ``version_name``.

Throughout the course of your project,
one of the Halotools development team may support your work by incorporating a new feature
into Halotools, and/or by accelerating the development of an existing feature branch
for the sake of your project.
In such an event, please consider a co-authorship invitation for that member of the development team
in addition to the above citations.
You can always request such support by
either a private email or by raising a public issue on GitHub and
either slack or personal email, or by raising a public issue on GitHub and
tagging the issue with the ``feature request`` label and/or ``question`` label.

Halotools License
Expand Down

0 comments on commit 1ea556e

Please sign in to comment.