diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml index 8ee69a81e..ae0999fc7 100644 --- a/.github/workflows/ci_tests.yml +++ b/.github/workflows/ci_tests.yml @@ -3,11 +3,11 @@ name: CI Tests on: push: branches: - - master + - main # tags: # run CI if specific tags are pushed pull_request: branches: - - master + - main jobs: # Github Actions supports ubuntu, windows, and macos virtual environments: diff --git a/README.md b/README.md index 3d4362c72..8cce1c3eb 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,9 @@ Although the *sim_manager* provides an object-oriented framework for creating a ## Project status -[![Coverage Status](https://coveralls.io/repos/astropy/halotools/badge.svg?branch=master&service=github)](https://coveralls.io/github/astropy/halotools?branch=master) +[![Coverage Status](https://coveralls.io/repos/astropy/halotools/badge.svg?branch=main&service=github)](https://coveralls.io/github/astropy/halotools?branch=main) -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. +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 main branch on GitHub and locally building the source code, as described in the installation instructions. --- diff --git a/docs/conf.py b/docs/conf.py index 8a17a9714..287d37409 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -162,7 +162,7 @@ if versionmod.version.release: edit_on_github_branch = "v" + versionmod.version.version else: - edit_on_github_branch = "master" + edit_on_github_branch = "main" edit_on_github_source_root = "" edit_on_github_doc_root = "docs" diff --git a/docs/install.rst b/docs/install.rst index 43b11f0b5..4d4c5b516 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,14 +1,14 @@ .. _step_by_step_install: -************************ +******************** Package Installation -************************ +******************** To install Halotools, you can either use 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 pip -==================== +========= The simplest way to install the latest release of the code is with pip. Before installation, be sure you have installed the package dependencies described in the :ref:`halotools_dependencies` section. If you will be :ref:`installing_halotools_with_virtualenv`, activate the environment before installing with pip:: @@ -19,7 +19,7 @@ Alternatively, you can install using the conda-forge channel on conda:: conda install -c conda-forge halotools Either pip or conda will install the latest official release of the code. -If instead you want the latest master branch, +If instead you want the latest main branch, you will need to build the code from source following the instructions in the next section. .. note:: @@ -56,7 +56,7 @@ The first step is to clone the halotools repository:: cd halotools Installing one of the official releases ------------------------------------------- +--------------------------------------- All official releases of the code are tagged with their version name, e.g., v0.7. To install a particular release:: @@ -66,15 +66,15 @@ To install a particular release:: This will install the v0.7 release of the code. Other official release versions (e.g., v0.5) can be installed similarly. -Installing the most recent master branch ------------------------------------------- +Installing the most recent main branch +-------------------------------------- If you prefer to use the most recent version of the code:: - git checkout master + git checkout main python setup.py install -This will install the master branch of the code that is currently under development. While the features in the official releases have a stable API, new features being developed in the master branch may not. However, the master branch may have new features and/or performance enhancements that you may wish to use for your science application. A concerted effort is made to ensure that only thoroughly tested and documented code appears in the public master branch, though Halotools users should be aware of the distinction between the bleeding edge version in master and the official release version available through pip. +This will install the main branch of the code that is currently under development. While the features in the official releases have a stable API, new features being developed in the main branch may not. However, the main branch may have new features and/or performance enhancements that you may wish to use for your science application. A concerted effort is made to ensure that only thoroughly tested and documented code appears in the public main branch, though Halotools users should be aware of the distinction between the bleeding edge version in main and the official release version available through pip. .. note:: @@ -134,7 +134,7 @@ Any of the above can be installed with either pip or conda. .. _verifying_your_installation: Verifying your installation -============================== +=========================== After installing the code and its dependencies, fire up a Python interpreter and check that the version number matches what you expect: @@ -175,13 +175,9 @@ For earlier versions, you will need to run the full test suite, which is more me 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. +Whether you installed the main 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 main 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. - - - - diff --git a/docs/installing_halotools_with_virtualenv.rst b/docs/installing_halotools_with_virtualenv.rst index bb4c31dc0..0a2f6f36c 100644 --- a/docs/installing_halotools_with_virtualenv.rst +++ b/docs/installing_halotools_with_virtualenv.rst @@ -22,7 +22,7 @@ Then install halotools into this environment:: pip install halotools -Or, alternatively, you can install the latest master branch by following the :ref:`install_from_source` instructions. +Or, alternatively, you can install the latest main branch by following the :ref:`install_from_source` instructions. Any additional packages you install into the ``ht07`` virtual environment will not impact your system-wide environment. Whenever you want to do science involving Halotools, just activate the environment and import the code. When you are done