Merge branch 'master' into feature-group-files

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <pytroll-conduct@lists.wisc.edu>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.rst

@@ -105,3 +105,32 @@ 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
+it is copied to this repository in
+`CODE_OF_CONDUCT.md <https://github.com/pytroll/satpy/blob/master/CODE_OF_CONDUCT.md>`_.
+
+As stated in the PyTroll home page, this code of conduct applies to the
+project space (GitHub) as well as the public space online and offline when
+an individual is representing the project or the community. Online examples
+of this include the PyTroll Slack team, mailing list, and the PyTroll twitter
+account. This code of conduct also applies to in-person situations like
+PyTroll Contributor Weeks (PCW), conference meet-ups, or any other time when
+the project is being represented.
+
+Any violations of this code of conduct will be handled by the core maintainers
+of the project including David Hoese, Martin Raspaud, and Adam Dybbroe.
+If you wish to report one of the maintainers for a violation and are
+not comfortable with them seeing it, please contact one or more of the other
+maintainers to report the violation. Responses to violations will be
+determined by the maintainers and may include one or more of the following:
+
+- Verbal warning
+- Ask for public apology
+- Temporary or permanent ban from in-person events
+- Temporary or permanent ban from online communication (Slack, mailing list, etc)
+
+For details see the official
+`code of conduct document <https://github.com/pytroll/satpy/blob/master/CODE_OF_CONDUCT.md>`_.

README.rst

@@ -24,3 +24,49 @@ to resample data to different uniform areas or grids.
 
 The documentation is available at
 http://satpy.readthedocs.org/.
+
+Installation
+------------
+
+SatPy can be installed from PyPI with pip:
+
+.. code-block:: bash
+
+    pip install satpy
+
+
+It is also available from `conda-forge` for conda installations:
+
+.. code-block:: bash
+
+    conda install -c conda-forge satpy
+
+Code of Conduct
+---------------
+
+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
+project space (GitHub) as well as the public space online and offline when
+an individual is representing the project or the community. Online examples
+of this include the PyTroll Slack team, mailing list, and the PyTroll twitter
+account. This code of conduct also applies to in-person situations like
+PyTroll Contributor Weeks (PCW), conference meet-ups, or any other time when
+the project is being represented.
+
+Any violations of this code of conduct will be handled by the core maintainers
+of the project including David Hoese, Martin Raspaud, and Adam Dybbroe.
+If you wish to report one of the maintainers for a violation and are
+not comfortable with them seeing it, please contact one or more of the other
+maintainers to report the violation. Responses to violations will be
+determined by the maintainers and may include one or more of the following:
+
+- Verbal warning
+- Ask for public apology
+- Temporary or permanent ban from in-person events
+- Temporary or permanent ban from online communication (Slack, mailing list, etc)
+
+For details see the official CODE_OF_CONDUCT.md_.
+
+.. _CODE_OF_CONDUCT.md: ./CODE_OF_CONDUCT.md

doc/source/data_download.rst

@@ -0,0 +1,73 @@
+Downloading Data
+================
+
+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
+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
+protocols.
+
+As a user there are two options for getting access to data:
+
+1. Download data to your local machine.
+2. Connect to a remote system that already has access to data.
+
+The most common case of a remote system having access to data is with a cloud
+computing service like Google Cloud Platform (GCP) or Amazon Web
+Services (AWS). Another possible case is an organization having direct
+broadcast antennas where they receive data directly from the satellite or
+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
+you know of others please let us know by either creating a GitHub issue or
+pull request.
+
+NOAA GOES on Amazon Web Services
+--------------------------------
+
+* `Resource Description <https://registry.opendata.aws/noaa-goes/>`__
+* `Data Browser <http://noaa-goes16.s3.amazonaws.com/index.html>`__
+* Associated Readers: ``abi_l1b``
+
+In addition ot the pages above, Brian Blaylock has prepared some instructions
+for using the ``rclone`` tool for downloading AWS data to a local machine. The
+instructions can be found
+`here <https://github.com/blaylockbk/pyBKB_v3/blob/master/rclone_howto.md>`_.
+
+NOAA GOES on Google Cloud Platform
+----------------------------------
+
+GOES-16
+^^^^^^^
+
+* `Resource Description <https://console.cloud.google.com/marketplace/details/noaa-public/goes-16>`__
+* `Data Browser <https://console.cloud.google.com/storage/browser/gcp-public-data-goes-16>`__
+* Associated Readers: ``abi_l1b``
+
+GOES-17
+^^^^^^^
+
+* `Resource Description <https://console.cloud.google.com/marketplace/details/noaa-public/goes-17>`__
+* `Data Browser <https://console.cloud.google.com/storage/browser/gcp-public-data-goes-17>`__
+* Associated Readers: ``abi_l1b``
+
+NOAA CLASS
+----------
+
+* `Data Ordering <https://www.class.ncdc.noaa.gov>`__
+* Associated Readers: ``viirs_sdr``
+
+NASA VIIRS Atmosphere SIPS
+--------------------------
+
+* `Resource Description <https://sips.ssec.wisc.edu/>`__
+* Associated Readers: ``viirs_l1b``
+
+EUMETSAT Data Center
+--------------------
+
+* `Data Ordering <https://eoportal.eumetsat.int>`__

doc/source/index.rst

@@ -33,6 +33,7 @@ installation.
 
     overview
     install
+    data_download
     examples
     quickstart
     readers

satpy/composites/__init__.py

@@ -60,7 +60,9 @@ class IncompatibleTimes(Exception):
 class CompositorLoader(object):
     """Read composites using the configuration files on disk."""
 
-    def __init__(self, ppp_config_dir=CONFIG_PATH):
+    def __init__(self, ppp_config_dir=None):
+        if ppp_config_dir is None:
+            ppp_config_dir = CONFIG_PATH
         self.modifiers = {}
         self.compositors = {}
         self.ppp_config_dir = ppp_config_dir

satpy/config.py

@@ -40,7 +40,9 @@
 PACKAGE_CONFIG_PATH = os.path.join(BASE_PATH, 'etc')
 
 
-def get_environ_config_dir(default=PACKAGE_CONFIG_PATH):
+def get_environ_config_dir(default=None):
+    if default is None:
+        default = PACKAGE_CONFIG_PATH
     return os.environ.get('PPP_CONFIG_DIR', default)