Merge pull request #699 from djhoese/doc-satpy-capitals

Rename SatPy to Satpy throughout documentation

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,7 +26,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Environment Info:**
  - OS: [e.g. OSX, Windows, Linux]
- - SatPy Version: [e.g. 0.9.0]
+ - Satpy Version: [e.g. 0.9.0]
  - PyResample Version:
  - Readers and writers dependencies (when relevant): [run `from satpy.config import check_satpy; check_satpy()`]
 

CONTRIBUTING.rst

@@ -2,15 +2,15 @@
 How to contribute
 =================
 
-Thank you for considering contributing to SatPy! SatPy's development team
+Thank you for considering contributing to Satpy! Satpy's development team
 is made up of volunteers so any help we can get is very appreciated.
 
 Contributions from users are what keep this community going. We welcome
 any contributions including bug reports, documentation fixes or updates,
-bug fixes, and feature requests. By contributing to SatPy you are providing
+bug fixes, and feature requests. By contributing to Satpy you are providing
 code that everyone can use and benefit from.
 
-The following guidelines will describe how the SatPy project structures
+The following guidelines will describe how the Satpy project structures
 its code contributions from discussion to code to package release.
 
 For more information on contributing to open source projects see
@@ -39,7 +39,7 @@ What can I do?
 - Read the :doc:`index` for more details on contributing code.
 - `Fork <https://help.github.com/articles/fork-a-repo/>`_ the repository on
   GitHub and install the package in development mode.
-- Update the SatPy documentation to make it clearer and more detailed.
+- Update the Satpy documentation to make it clearer and more detailed.
 - Contribute code to either fix a bug or add functionality and submit a
   `Pull Request <https://help.github.com/articles/creating-a-pull-request/>`_.
 - Make an example Jupyter Notebook and add it to the
@@ -53,33 +53,33 @@ fault. When you submit your changes to be merged as a GitHub
 `Pull Request <https://help.github.com/articles/creating-a-pull-request/>`_
 they will be automatically tested and checked against coding style rules.
 Before they are merged they are reviewed by at least one maintainer of the
-SatPy project. If anything needs updating, we'll let you know.
+Satpy project. If anything needs updating, we'll let you know.
 
 What is expected?
 =================
 
-You can expect the SatPy maintainers to help you. We are all volunteers,
+You can expect the Satpy maintainers to help you. We are all volunteers,
 have jobs, and occasionally go on vacations. We will try our best to answer
 your questions as soon as possible. We will try our best to understand your
 use case and add the features you need. Although we strive to make
-SatPy useful for everyone there may be some feature requests that we can't
+Satpy useful for everyone there may be some feature requests that we can't
 allow if they would require breaking existing features. Other features may
 be best for a different package, PyTroll or otherwise. Regardless, we will
 help you find the best place for your feature and to make it possible to do
 what you want.
 
-We, the SatPy maintainers, expect you to be patient, understanding, and
-respectful of both developers and users. SatPy can only be successful if
+We, the Satpy maintainers, expect you to be patient, understanding, and
+respectful of both developers and users. Satpy can only be successful if
 everyone in the community feels welcome. We also expect you to put in as
-much work as you expect out of us. There is no dedicated PyTroll or SatPy
+much work as you expect out of us. There is no dedicated PyTroll or Satpy
 support team, so there may be times when you need to do most of the work
 to solve your problem (trying different test cases, environments, etc).
 
 Being respectful includes following the style of the existing code for any
 code submissions. Please follow
 `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ style guidelines and
 limit lines of code to 80 characters whenever possible and when it doesn't
-hurt readability. SatPy follows
+hurt readability. Satpy follows
 `Google Style Docstrings <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_
 for all code API documentation. When in doubt use the existing code as a
 guide for how coding should be done.
@@ -89,7 +89,7 @@ guide for how coding should be done.
 How do I get help?
 ==================
 
-The SatPy developers (and all other PyTroll package developers) monitor the:
+The Satpy developers (and all other PyTroll package developers) monitor the:
 
 - `Mailing List <https://groups.google.com/group/pytroll>`_
 - `Slack chat <https://pytroll.slack.com/>`_ (get an `invitation <https://pytrollslackin.herokuapp.com/>`_)
@@ -99,17 +99,17 @@ How do I submit my changes?
 ===========================
 
 Any contributions should start with some form of communication (see above) to
-let the SatPy maintainers know how you plan to help. The larger the
+let the Satpy maintainers know how you plan to help. The larger the
 contribution the more important direct communication is so everyone can avoid
 duplicate code and wasted time.
-After talking to the SatPy developers any additional work like code or
+After talking to the Satpy developers any additional work like code or
 documentation changes can be provided as a GitHub
 `Pull Request <https://help.github.com/articles/creating-a-pull-request/>`_.
 
 Code of Conduct
 ===============
 
-SatPy follows the same code of conduct as the PyTroll project. For reference
+Satpy follows the same code of conduct as the PyTroll project. For reference
 it is copied to this repository in
 `CODE_OF_CONDUCT.md <https://github.com/pytroll/satpy/blob/master/CODE_OF_CONDUCT.md>`_.
 

README.rst

@@ -14,9 +14,9 @@ Satpy
     :target: https://badge.fury.io/py/satpy
 
 
-The SatPy package is a python library for reading and manipulating
+The Satpy package is a python library for reading and manipulating
 meteorological remote sensing data and writing it to various image and
-data file formats. SatPy comes with the ability to make various RGB
+data file formats. Satpy comes with the ability to make various RGB
 composites directly from satellite instrument channel data or higher level
 processing output. The
 `pyresample <http://pyresample.readthedocs.io/en/latest/>`_ package is used
@@ -28,7 +28,7 @@ http://satpy.readthedocs.org/.
 Installation
 ------------
 
-SatPy can be installed from PyPI with pip:
+Satpy can be installed from PyPI with pip:
 
 .. code-block:: bash
 
@@ -44,7 +44,7 @@ It is also available from `conda-forge` for conda installations:
 Code of Conduct
 ---------------
 
-SatPy follows the same code of conduct as the PyTroll project. For reference
+Satpy follows the same code of conduct as the PyTroll project. For reference
 it is copied to this repository in CODE_OF_CONDUCT.md_.
 
 As stated in the PyTroll home page, this code of conduct applies to the

RELEASING.md

@@ -1,4 +1,4 @@
-# Releasing SatPy
+# Releasing Satpy
 
 1. checkout master
 2. pull from repo

doc/README

@@ -4,7 +4,7 @@ by running:
     make html
 
 The generated HTML documentation pages are available in `build/html`. If
-SatPy's API has changed (new functions, modules, classes, etc) then the
+Satpy's API has changed (new functions, modules, classes, etc) then the
 API documentation should be regenerated before running the above make
 command.
 

doc/source/conf.py

@@ -75,7 +75,7 @@ def __getattr__(cls, name):
 master_doc = 'index'
 
 # General information about the project.
-project = u'SatPy'
+project = u'Satpy'
 copyright = u'2009-{}, The PyTroll Team'.format(datetime.utcnow().strftime("%Y"))
 
 # The version info for the project you're documenting, acts as replacement for

doc/source/data_download.rst

@@ -1,9 +1,9 @@
 Downloading Data
 ================
 
-One of the main features of SatPy is its ability to read various satellite
+One of the main features of Satpy is its ability to read various satellite
 data formats. However, it does not currently provide any functionality for
-downloading data from any remote sources. SatPy assumes all data is available
+downloading data from any remote sources. Satpy assumes all data is available
 through the local system, either as a local directory or network
 mounted file systems. Certain readers that use ``xarray`` to open data files
 may be able to load files from remote systems by using OpenDAP or similar
@@ -22,7 +22,7 @@ satellite mission organization (NOAA, NASA, EUMETSAT, etc). In these cases
 data is usually available as a mounted network file system and can be accessed
 like a normal local path (with the added latency of network communications).
 
-Below are some data sources that provide data that can be read by SatPy. If
+Below are some data sources that provide data that can be read by Satpy. If
 you know of others please let us know by either creating a GitHub issue or
 pull request.
 

doc/source/dev_guide/custom_reader.rst

@@ -1,5 +1,5 @@
 =================================
- Adding a Custom Reader to SatPy
+ Adding a Custom Reader to Satpy
 =================================
 
 In order to add a reader to satpy, you will need to create two files:
@@ -14,7 +14,7 @@ format for SEVIRI data
 Naming your reader
 ------------------
 
-SatPy tries to follow a standard scheme for naming its readers. These names
+Satpy tries to follow a standard scheme for naming its readers. These names
 are used in filenames, but are also used by users so it is important that
 the name be recognizable and clear. Although some
 special cases exist, most fit in to the following naming scheme:
@@ -57,7 +57,7 @@ if needed (ex. goes-imager).
 
 The existing :ref:`reader's table <reader_table>` can be used for reference.
 When in doubt, reader names can be discussed in the github pull
-request when this reader is added to SatPy or a github issue.
+request when this reader is added to Satpy or a github issue.
 
 The YAML file
 -------------

doc/source/dev_guide/index.rst

@@ -18,19 +18,19 @@ at the pages listed below.
 Coding guidelines
 =================
 
-SatPy is part of `PyTroll <http://pytroll.github.io/>`_,
+Satpy is part of `PyTroll <http://pytroll.github.io/>`_,
 and all code should follow the
 `PyTroll coding guidelines and best
 practices <http://pytroll.github.io/guidelines.html>`_.
 
-SatPy currently supports Python 2.7 and 3.4+. All code should be written to
+Satpy currently supports Python 2.7 and 3.4+. All code should be written to
 be compatible with these versions.
 
 Development installation
 ========================
 
 See the :doc:`../install` section for basic installation instructions. When
-it comes time to install SatPy it should be installed from a clone of the git
+it comes time to install Satpy it should be installed from a clone of the git
 repository and in development mode so that local file changes are
 automatically reflected in the python environment. We highly recommend making
 a separate conda environment or virtualenv for development.
@@ -44,15 +44,15 @@ clone your fork. The package can then be installed in development by doing::
 Running tests
 =============
 
-SatPy tests are written using the python :mod:`unittest` module and the tests
+Satpy tests are written using the python :mod:`unittest` module and the tests
 can be executed by running::
 
     python setup.py test
 
 Documentation
 =============
 
-SatPy's documentation is built using Sphinx. All documentation lives in the
+Satpy's documentation is built using Sphinx. All documentation lives in the
 ``doc/`` directory of the project repository. After editing the source files
 there the documentation can be generated locally::
 

doc/source/dev_guide/xarray_migration.rst

@@ -5,16 +5,16 @@ Migrating to xarray and dask
 Many python developers dealing with meteorologic satellite data begin with
 using NumPy arrays directly. This work usually involves masked arrays,
 boolean masks, index arrays, and reshaping. Due to the libraries used by
-SatPy these operations can't always be done in the same way. This guide acts
-as a starting point for new SatPy developers in transitioning from NumPy's
-array operations to SatPy's operations, although they are very similar.
+Satpy these operations can't always be done in the same way. This guide acts
+as a starting point for new Satpy developers in transitioning from NumPy's
+array operations to Satpy's operations, although they are very similar.
 
 To provide the most functionality for users,
-SatPy uses the `xarray <http://xarray.pydata.org/en/stable/>`_ library's
+Satpy uses the `xarray <http://xarray.pydata.org/en/stable/>`_ library's
 :class:`~xarray.DataArray` object as the main representation for its data.
 DataArray objects can also benefit from the
 `dask <https://dask.pydata.org/en/latest/>`_ library. The combination of
-these libraries allow SatPy to easily distribute operations over multiple
+these libraries allow Satpy to easily distribute operations over multiple
 workers, lazy evaluate operations, and keep track additional metadata and
 coordinate information.
 
@@ -38,7 +38,7 @@ To create such an array, you can do for example
                                 attrs={'sensor': 'olci'})
 
 where ``my_data`` can be a regular numpy array, a numpy memmap, or, if you
-want to keep things lazy, a dask array (more on dask later). SatPy uses dask
+want to keep things lazy, a dask array (more on dask later). Satpy uses dask
 arrays with all of its DataArrays.
 
 Dimensions
@@ -235,7 +235,7 @@ Regular arithmetic operations are provided, and generate another dask array.
 
 In order to compute the actual data during testing, use the
 :func:`~dask.compute` method.
-In normal SatPy operations you will want the data to be evaluated as late as
+In normal Satpy operations you will want the data to be evaluated as late as
 possible to improve performance so `compute` should only be used when needed.
 
     >>> (arr1 + arr2).compute()

doc/source/examples.rst

@@ -1,7 +1,7 @@
 Examples
 ========
 
-SatPy examples are available as Jupyter Notebooks on the
+Satpy examples are available as Jupyter Notebooks on the
 `pytroll-examples <https://github.com/pytroll/pytroll-examples/tree/master/satpy>`_
 git repository. They include python code, PNG images, and descriptions of
 what the example is doing. Below is a list of some of the examples and a brief
@@ -22,7 +22,7 @@ as explanations in the various sections of this documentation.
     * - `Sentinel-3 OLCI True Color <https://github.com/pytroll/pytroll-examples/blob/master/satpy/OLCI%20L1B.ipynb>`_
       - Reading OLCI data from Sentinel 3 with Pytroll/Satpy
     * - `Sentinel 2 MSI true color <https://github.com/pytroll/pytroll-examples/blob/master/satpy/Sentinel%202%20MSI%20true%20color.ipynb>`_
-      - Reading MSI data from Sentinel 2 with Pytroll/SatPy
+      - Reading MSI data from Sentinel 2 with Pytroll/Satpy
     * - `Suomi-NPP VIIRS SDR True Color <https://github.com/pytroll/pytroll-examples/blob/master/satpy/satpy_rayleigh_iband_enhanced.ipynb>`_
       - Generate a rayleigh corrected true color RGB from VIIRS I- and M-bands
     * - `Aqua/Terra MODIS True Color <https://github.com/pytroll/pytroll-examples/blob/master/satpy/satpy_rayleigh_modis.ipynb>`_

doc/source/faq.rst

@@ -2,7 +2,7 @@ FAQ
 ===
 
 Below you'll find frequently asked questions, performance tips, and other
-topics that don't really fit in to the rest of the SatPy documentation.
+topics that don't really fit in to the rest of the Satpy documentation.
 
 If you have any other questions that aren't answered here feel free to make
 an issue on GitHub or talk to us on the Slack team or mailing list. See the
@@ -12,24 +12,24 @@ an issue on GitHub or talk to us on the Slack team or mailing list. See the
     :depth: 1
     :local:
 
-Why is SatPy slow on my powerful machine?
+Why is Satpy slow on my powerful machine?
 -----------------------------------------
 
-SatPy depends heavily on the dask library for its performance. However,
+Satpy depends heavily on the dask library for its performance. However,
 on some systems dask's default settings can actually hurt performance.
 By default dask will create a "worker" for each logical core on your
 system. In most systems you have twice as many logical cores
 (also known as threaded cores) as physical cores. Managing and communicating
 with all of these workers can slow down dask, especially when they aren't all
-being used by most SatPy calculations. One option is to limit the number of
+being used by most Satpy calculations. One option is to limit the number of
 workers by doing the following at the **top** of your python code:
 
 .. code-block:: python
 
     import dask
     from multiprocessing.pool import ThreadPool
     dask.config.set(pool=ThreadPool(8))
-    # all other SatPy imports and code
+    # all other Satpy imports and code
 
 This will limit dask to using 8 workers. Typically numbers between 4 and 8
 are good starting points. Number of workers can also be set from an
@@ -43,15 +43,15 @@ isn't necessary:
 Similarly, if you have many workers processing large chunks of data you may
 be using much more memory than you expect. If you limit the number of workers
 *and* the size of the data chunks being processed by each worker you can
-reduce the overall memory usage. Default chunk size can be configured in SatPy
+reduce the overall memory usage. Default chunk size can be configured in Satpy
 by setting the following environment variable:
 
 .. code-block:: bash
 
     export PYTROLL_CHUNK_SIZE=2048
 
 This could also be set inside python using ``os.environ``, but must be set
-**before** SatPy is imported. This value defaults to 4096, meaning each
+**before** Satpy is imported. This value defaults to 4096, meaning each
 chunk of data will be 4096 rows by 4096 columns. In the future setting this
 value will change to be easier to set in python.
 
@@ -93,8 +93,8 @@ How do I avoid memory errors?
 -----------------------------
 
 If your environment is using many dask workers, it may be using more memory
-than it needs to be using. See the "Why is SatPy slow on my powerful machine?"
-question above for more information on changing SatPy's memory usage.
+than it needs to be using. See the "Why is Satpy slow on my powerful machine?"
+question above for more information on changing Satpy's memory usage.
 
 Reducing GDAL output size?
 --------------------------