Skip to content

Commit 61982c9

Browse files
committed
Remove references to halotools.test() in documentation
1 parent 1985190 commit 61982c9

File tree

2 files changed

+0
-37
lines changed

2 files changed

+0
-37
lines changed

docs/install.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -157,28 +157,6 @@ This will show where your active version is located on your machine. You can man
157157

158158
Once you have installed the package, see :ref:`getting_started` for instructions on how to get up and running.
159159

160-
Testing your installation
161-
=========================
162-
163-
To verify that your Halotools installation runs properly, navigate to some new working directory and execute the test suite. If you installed Halotools into a virtual environment as described in the :ref:`installing_halotools_with_virtualenv` section of the documentation, activate the environment before spawning a python session and executing the code below.
164-
165-
For halotools versions v0.6 and later, there is a `test_installation` feature that runs a few simple tests scattered throughout the code base:
166-
167-
.. code:: python
168-
169-
import halotools
170-
halotools.test_installation() # v0.6 and later
171-
172-
For earlier versions, you will need to run the full test suite, which is more memory intensive and takes several minutes to run:
173-
174-
.. code:: python
175-
176-
halotools.test() # v0.5 and earlier
177-
178-
179-
Whether you installed the master branch or a release branch, the message that concludes the execution of the test suite should not indicate that there were any errors or failures. A typical acceptable test suite report will read something like "445 passed, 45 skipped in 383.2 seconds". If you installed the master branch, your message may read something like "475 passed, 4 xfailed in 374.3 seconds". The *xfail* marker is shorthand for "expected failure"; tests marked by *xfail* do not indicate a bug or installation problem; instead, this indicates that there is a new feature that has only been partially implemented. If you encounter problems when running the test suite, please be sure you have installed the package dependencies first before raising a Github Issue and/or contacting the Halotools developers.
180-
181-
182160
Troubleshooting
183161
==================
184162
See :ref:`installation_troubleshooting` for solutions to known installation-related problems.

docs/quickstart_and_tutorials/getting_started_overview.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,6 @@ get up and running with the default halo catalog.
3434
First steps with Halotools
3535
================================
3636

37-
Running the test suite
38-
------------------------
39-
40-
After installing the code and its dependencies, navigate to some new working directory and execute the test suite. (This only needs to be done once per installed version.) For halotools versions v0.6 and later, you can use the `test_installation` feature that runs a few select tests scattered throughout the repository. For versions v0.5 and earlier, you will need to run the full test suite, which is much more CPU- and memory-intensive.
41-
42-
.. code:: python
43-
44-
import halotools
45-
halotools.installation_test() # v0.6 and later
46-
halotools.test() # v0.5 and earlier
47-
48-
The full test suite is memory intensive and takes several minutes to run. It will generate a few small, temporary dummy files that you can delete or just ignore.
49-
50-
See :ref:`verifying_your_installation` for details about the message that prints after you run the test suite.
51-
5237
.. _download_default_halos:
5338

5439
Downloading the default halo catalog

0 commit comments

Comments
 (0)