From 1ea556e7b7c56e62f3df39e09cc085a3d45c79a7 Mon Sep 17 00:00:00 2001 From: Andrew Hearin Date: Wed, 29 Jan 2020 17:50:50 -0600 Subject: [PATCH] Updated docs to match v0.7 --- README.md | 10 +++------- .../development/citing_halotools.rst | 12 +++--------- 2 files changed, 6 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 23d97b16d..3d4362c72 100644 --- a/README.md +++ b/README.md @@ -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. --- diff --git a/docs/quickstart_and_tutorials/development/citing_halotools.rst b/docs/quickstart_and_tutorials/development/citing_halotools.rst index 5c79791c1..9cc0894ac 100644 --- a/docs/quickstart_and_tutorials/development/citing_halotools.rst +++ b/docs/quickstart_and_tutorials/development/citing_halotools.rst @@ -9,20 +9,14 @@ 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 @@ -30,7 +24,7 @@ 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