@@ -262,7 +262,7 @@ Beyond this, we emphasize two important considerations regarding PypeIt versioni
262262 environments with different PypeIt versions installed or reprocess data with
263263 your currently installed PypeIt version.
264264
265- - **Cached files are version-specific. ** Every time you upgrade pypeit , we
265+ - **Cached files are version-specific. ** Every time you upgrade PypeIt , we
266266 recommend deleting your existing cache and starting fresh! See
267267 :ref: `view-cache `. The only caveat to this is if you are actively using
268268 multiple versions of PypeIt (in different environments), meaning you will
@@ -349,7 +349,7 @@ cache. To list the cache contents, use the ``-l`` option:
349349 github 1.15.1 tests solution_arrays.npz
350350
351351 Note that the files hosted on GitHub will be specific to a branch or version of
352- PypeIt. **Every time you upgrade pypeit , we recommend deleting your existing
352+ PypeIt. **Every time you upgrade PypeIt , we recommend deleting your existing
353353cache and starting fresh! **
354354
355355**Local files ** that have been installed into the cache (e.g., using
@@ -455,7 +455,7 @@ can be included in the PypeIt repository.
455455
456456 Because PypeIt uses the cache system to manage the local files, it will
457457 associate each file with the version of the code used to install it in the
458- cache. Every time you upgrade your pypeit version, you should delete the
458+ cache. Every time you upgrade your PypeIt version, you should delete the
459459 local files from the cache (this will not remove the local file itself) and
460460 re-install them using the upgraded version of PypeIt. See :ref: `view-cache `
461461 and :ref: `upgrade `.
@@ -537,7 +537,7 @@ Python (see :ref:`dependencies`):
537537* `PySide <https://wiki.qt.io/Qt_for_Python >`_
538538
539539At least one of those bindings must be installed for the interactive GUIs to
540- work. By default `` pypeit `` will install ``pyqt6 ``. Other backends can be used
540+ work. By default PypeIt will install ``pyqt6 ``. Other backends can be used
541541by installing them manually via ``pip `` or ``conda `` and then setting the ``QT_API ``
542542environment variable. See the `QtPy documentation <https://github.com/spyder-ide/qtpy >`_
543543for more details.
@@ -630,7 +630,7 @@ spectrum from the Shane/KAST spectrograph at Lick Observatory.
630630Troubleshooting
631631===============
632632
633- If you have trouble installing pypeit , you're encouraged to join our `PypeIt
633+ If you have trouble installing PypeIt , you're encouraged to join our `PypeIt
634634Users Slack <https://pypeit-users.slack.com> `__ using `this invitation
635635link <invite_> `_ and post your issue to the ``#installing `` channel. Below is an
636636incomplete list of issues that users have reported in the past. In addition to
@@ -639,7 +639,7 @@ let us know if these suggestions do not work for you.*
639639
640640----
641641
642- **I am trying to install pypeit for the first time and it fails! **: The root
642+ **I am trying to install PypeIt for the first time and it fails! **: The root
643643problem of this can be system dependent:
644644
645645 - First, *always * make sure you install the code into a fresh environment.
@@ -656,23 +656,23 @@ problem of this can be system dependent:
656656
657657----
658658
659- **I am trying to upgrade pypeit and it fails! **: First try uninstalling your
660- current pypeit version:
659+ **I am trying to upgrade PypeIt and it fails! **: First try uninstalling your
660+ current PypeIt version:
661661
662662.. code-block :: bash
663663
664664 pip uninstall pypeit
665665
666666 Then reinstall it. If that also fails, try creating a fresh environment and
667- reinstalling pypeit in that new environment.
667+ reinstalling PypeIt in that new environment.
668668
669669----
670670
671671**The installation process succeeded, but the code is faulting! **: This could
672672be for a few reasons:
673673
674- - Recall that pypeit isn't necessarily backwards compatible. If you've
675- upgraded pypeit and tried to use it with data that was reduced by a previous
674+ - Recall that PypeIt isn't necessarily backwards compatible. If you've
675+ upgraded PypeIt and tried to use it with data that was reduced by a previous
676676 version, the fault may because of changes between versions. You will either
677677 need to revert to your previous version or reprocess the data.
678678
@@ -707,6 +707,6 @@ Slack. However, here are a few things to note and/or try:
707707 - And, of course, the code will have bugs. If you find one, the more
708708 information you provide the developers, the easier it will be for us to track
709709 down the issue. Valuable information includes your OS, OS version, python
710- version, pypeit version, and the full Traceback provided with the error. QA
710+ version, PypeIt version, and the full Traceback provided with the error. QA
711711 plots and ``ginga `` screen grabs that illustrate the issue are also very
712712 helpful!
0 commit comments