Skip to content

Commit

Permalink
Merge pull request #1123 from astropy/recheck_testing
Browse files Browse the repository at this point in the history
Trivial change to readme to re-trigger test runners
  • Loading branch information
aphearin authored Feb 20, 2025
2 parents 5512a78 + 61982c9 commit dbba4f4
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 38 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,4 @@ If you use Halotools modules to support your science publication, please cite `H
License
-------

Halotools is licensed by Argonne National Lab under a 3-clause BSD style license - see the licenses/LICENSE.rst file.
Halotools is licensed by Argonne National Lab under a 3-clause BSD style license - see the licenses/LICENSE.rst file.
22 changes: 0 additions & 22 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,28 +157,6 @@ This will show where your active version is located on your machine. You can man

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

Testing your installation
=========================

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.

For halotools versions v0.6 and later, there is a `test_installation` feature that runs a few simple tests scattered throughout the code base:

.. code:: python
import halotools
halotools.test_installation() # v0.6 and later
For earlier versions, you will need to run the full test suite, which is more memory intensive and takes several minutes to run:

.. code:: python
halotools.test() # v0.5 and earlier
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.


Troubleshooting
==================
See :ref:`installation_troubleshooting` for solutions to known installation-related problems.
15 changes: 0 additions & 15 deletions docs/quickstart_and_tutorials/getting_started_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,6 @@ get up and running with the default halo catalog.
First steps with Halotools
================================

Running the test suite
------------------------

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.

.. code:: python
import halotools
halotools.installation_test() # v0.6 and later
halotools.test() # v0.5 and earlier
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.

See :ref:`verifying_your_installation` for details about the message that prints after you run the test suite.

.. _download_default_halos:

Downloading the default halo catalog
Expand Down

0 comments on commit dbba4f4

Please sign in to comment.