From 563b6a9f889e8b55bda73810c46875492beb1cc5 Mon Sep 17 00:00:00 2001 From: Andrew Hearin Date: Tue, 27 Sep 2022 08:16:27 -0500 Subject: [PATCH 1/3] Update installation instructions --- README.rst | 7 ++++--- docs/install.rst | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index e36dfe434..e6622727c 100644 --- a/README.rst +++ b/README.rst @@ -14,16 +14,17 @@ The code is publicly available at https://github.com/astropy/halotools. Installation ------------- -The simplest way to install the latest release of the code is with conda-forge:: +The simplest and most reliable way to install the latest release of the code is with conda-forge:: conda install -c conda-forge halotools -Or alternatively, you can install using pip:: +Pip installation is not recommended because the conda-forge dependency solver is much more robust. +However, users who prefer pip can install via:: pip install halotools You can find detailed installation instructions -in the **Package Installation** section of http://halotools.readthedocs.io. After installing the package, you should navigate to the *Quickstart Guides and Tutorials* section and follow the *Getting started with Halotools* 10-minute tutorial. This will get you set up with the default halo catalog so that you can quickly get started with creating mock galaxy populations. +in the :ref:`step_by_step_install` section of http://halotools.readthedocs.io. After installing the package, you should follow the :ref:`step_by_step_install` 10-minute tutorial. This will get you set up with the default halo catalog so that you can quickly get started with creating mock galaxy populations. Documentation diff --git a/docs/install.rst b/docs/install.rst index fc0e3cc2c..7cf13bfef 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -4,18 +4,19 @@ Package Installation ************************ -To install Halotools, you can use conda-forge, pip, or clone the repo from GitHub and build the source code. +To install Halotools, you can use conda-forge (recommended), pip, or clone the repo from GitHub and build the source code. Either way, be sure to read the :ref:`halotools_dependencies` section prior to installation. Using conda-forge and pip ========================= -The simplest way to install the latest release of the code is with conda-forge. +The simplest and most reliable way to install the latest release of the code is with conda-forge. If you will be :ref:`installing_halotools_with_virtualenv`, activate the environment before installing:: conda install -c conda-forge halotools -Alternatively, you can install using pip:: +Pip installation is not recommended because the conda-forge dependency solver is much more robust. +However, users who prefer pip can install via:: pip install halotools From a59711e897c1a9cba5507e8208a7c69dad2291f4 Mon Sep 17 00:00:00 2001 From: Andrew Hearin Date: Tue, 27 Sep 2022 08:31:44 -0500 Subject: [PATCH 2/3] Add forgotten test skip --- README.rst | 13 ++++++++++++- .../sim_manager/tests/test_download_manager.py | 1 + 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e6622727c..48dfe85b9 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,18 @@ However, users who prefer pip can install via:: pip install halotools You can find detailed installation instructions -in the :ref:`step_by_step_install` section of http://halotools.readthedocs.io. After installing the package, you should follow the :ref:`step_by_step_install` 10-minute tutorial. This will get you set up with the default halo catalog so that you can quickly get started with creating mock galaxy populations. +in the :ref:`step_by_step_install` section of http://halotools.readthedocs.io. +After installing the package, you should follow the :ref:`step_by_step_install` 10-minute tutorial. +This will get you set up with the default halo catalog so that you can quickly get started +with creating mock galaxy populations. + +After installation, it is recommended that you download the default halo catalog:: + + $ download_initial_halocat.py + +Halotools works with any halo catalog, but downloading the default halo catalog +automatically configures the halotools cache directory. More information about +halo catalog download options in the :ref:`download_default_halos` section of the 10-minute tutorial. Documentation diff --git a/halotools/sim_manager/tests/test_download_manager.py b/halotools/sim_manager/tests/test_download_manager.py index 5ca688482..e620f4bd2 100644 --- a/halotools/sim_manager/tests/test_download_manager.py +++ b/halotools/sim_manager/tests/test_download_manager.py @@ -519,6 +519,7 @@ def test_download_ptcl_table3(self): substr = "you must set the ``overwrite`` keyword argument to True." assert substr in err.value.args[0] + @pytest.mark.skipif("not APH_MACHINE") def test_download_ptcl_table4(self): """ """ with pytest.raises(HalotoolsError) as err: From b415f98ba431c77398d1e08351908c04e1451798 Mon Sep 17 00:00:00 2001 From: Andrew Hearin Date: Tue, 27 Sep 2022 08:51:58 -0500 Subject: [PATCH 3/3] Fix links in readme --- README.rst | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 48dfe85b9..754947989 100644 --- a/README.rst +++ b/README.rst @@ -23,20 +23,11 @@ However, users who prefer pip can install via:: pip install halotools -You can find detailed installation instructions -in the :ref:`step_by_step_install` section of http://halotools.readthedocs.io. -After installing the package, you should follow the :ref:`step_by_step_install` 10-minute tutorial. -This will get you set up with the default halo catalog so that you can quickly get started -with creating mock galaxy populations. - -After installation, it is recommended that you download the default halo catalog:: - - $ download_initial_halocat.py - -Halotools works with any halo catalog, but downloading the default halo catalog -automatically configures the halotools cache directory. More information about -halo catalog download options in the :ref:`download_default_halos` section of the 10-minute tutorial. +You can find detailed installation instructions `halotools.readthedocs.io `_. +After installing the package, you should navigate to the *Quickstart Guides and Tutorials* +section and follow the *Getting started with Halotools* 10-minute tutorial. +This will get you set up with the default halo catalog so that you can quickly get started with creating mock galaxy populations. Documentation -------------