Merge pull request #52 from pysat/sty/inst_rename

BUG/STY: update platform names
pysat · May 18, 2021 · ee6fa10 · ee6fa10
2 parents 48a57bb + fa88253
commit ee6fa10
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,11 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.3.0] - 2020-12-03
+## [0.3.0] - 2021-05-17
 - Update sat_id to inst_id for pysat 3.0 compatibility
 - migrate pyglow interface to pysatIncubator
 - Style updates for consistency with pysat 3.0
   - Use `cadence` instead of `freq`
+  - Use 'missions' as the platform name ('pysat' now reserved for core code)
 - Migrate CI testing to Github Actions
 
 ## [0.2.1] - 2020-07-29

diff --git a/description.txt b/description.txt
@@ -1,4 +1,4 @@
-pysatMissions allows users to run build simulated satellites for TLE info and add empirical data. It includes the pysat_sgp4 instrument module which can be imported into pysat.
+pysatMissions allows users to run build simulated satellites for TLE info and add empirical data. It includes the missions_sgp4 and missions_ephem instrument modules which can be imported into pysat.
 
 Main Features
 -------------

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -3,8 +3,8 @@ Introduction
 ============
 
 pysatMissions allows users to run build simulated satellites for Two-Line
-Elements (TLE) and add empirical data.  It includes the pysat_ephem and
-pysat_sgp4 instrument modules which can be imported into pysat.
+Elements (TLE) and add empirical data.  It includes the missions_ephem and
+missions_sgp4 instrument modules which can be imported into pysat.
 
 Main Features
 -------------

diff --git a/docs/supported_instruments.rst b/docs/supported_instruments.rst
@@ -1,18 +1,18 @@
 Supported Instruments
 =====================
 
-.. _pysat_ephem:
+.. _missions_ephem:
 
 Pysat ephem
 -----------
 
-.. automodule:: pysatMissions.instruments.pysat_ephem
+.. automodule:: pysatMissions.instruments.missions_ephem
    :members:
 
-.. _pysat_sgp4:
+.. _missions_sgp4:
 
 Pysat SGP4
 ----------
 
-.. automodule:: pysatMissions.instruments.pysat_sgp4
+.. automodule:: pysatMissions.instruments.missions_sgp4
    :members:
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -5,23 +5,23 @@ Tutorial
 Set up sgp4 with pysat
 ----------------------
 
-The :ref:`pysat_sgp4` instrument within pysatMissions is designed to be run
+The :ref:`missions_sgp4` instrument within pysatMissions is designed to be run
 like any pysat instrument.  To access, use
 
 .. code:: python
 
   import pysat
-  from pysatMissions.instruments import pysat_sgp4
+  from pysatMissions.instruments import missions_sgp4
 
-  sgp4 = pysat.Instrument(inst_module=pysat_sgp4)
+  sgp4 = pysat.Instrument(inst_module=missions_sgp4)
 
 This can be permanently added via the instrument registry.
 
 .. code:: python
 
   import pysat
   import pysatMissions
-  pysat.utils.registry.register('pysatMissions.instruments.pysat_sgp4')
+  pysat.utils.registry.register('pysatMissions.instruments.missions_sgp4')
 
 or, to register all modules in pysat
 
@@ -32,15 +32,15 @@ or, to register all modules in pysat
   pysat.utils.registry.register_by_module(pysatMissions.instruments)
 
 
-For other instruments, simply replace the module name (in this case, pysat_sgp4)
+For other instruments, simply replace the module name (in this case, missions_sgp4)
 with the name of the desired instrument.
 
 Orbital Propagators
 -------------------
 
 Currently, two orbital propagators are included with pysatMissions. The
-:ref:`pysat_sgp4` instrument uses the wgs72 gravity model to provide satellite
-position and velocity in ECI co-ordinates.  The :ref:`pysat_ephem` instrument
+:ref:`missions_sgp4` instrument uses the wgs72 gravity model to provide satellite
+position and velocity in ECI co-ordinates.  The :ref:`missions_ephem` instrument
 uses the ephem pysat package to calculate an orbit in lat/lon/alt and ECEF
 co-ordinates.  As an example, it also loads a series of empirical models to
 provide simulated magnetic data as an aid for mission planning.
@@ -51,7 +51,7 @@ one-second cadence, run
 
 .. code:: python
 
-  sgp4 = pysat.Instrument(inst_module=pysat_sgp4, num_samples=3600)
+  sgp4 = pysat.Instrument(inst_module=missions_sgp4, num_samples=3600)
   sgp4.load(2019, 1)
 
 

diff --git a/pysatMissions/instruments/__init__.py b/pysatMissions/instruments/__init__.py
@@ -3,6 +3,6 @@
 the instrument modules to be used with pysat
 """
 
-from pysatMissions.instruments import pysat_ephem, pysat_sgp4
+from pysatMissions.instruments import missions_ephem, missions_sgp4
 
-__all__ = ['pysat_ephem', 'pysat_sgp4']
+__all__ = ['missions_ephem', 'missions_sgp4']
diff --git a/pysatMissions/instruments/pysat_ephem.py → pysatMissions/instruments/missions_ephem.py b/pysatMissions/instruments/pysat_ephem.py → pysatMissions/instruments/missions_ephem.py
@@ -8,7 +8,7 @@
 Properties
 ----------
 platform
-    'pysat'
+    'missions'
 name
     'ephem'
 tag
@@ -35,7 +35,7 @@
 logger = pysat.logger
 
 # pysat required parameters
-platform = 'pysat'
+platform = 'missions'
 name = 'ephem'
 # dictionary of data 'tags' and corresponding description
 tags = {'': 'Satellite simulation data set'}

diff --git a/pysatMissions/instruments/pysat_sgp4.py → pysatMissions/instruments/missions_sgp4.py b/pysatMissions/instruments/pysat_sgp4.py → pysatMissions/instruments/missions_sgp4.py
@@ -6,7 +6,7 @@
 Properties
 ----------
 platform
-    'pysat'
+    'missions'
 name
     'sgp4'
 tag
@@ -27,7 +27,7 @@
 logger = pysat.logger
 
 # pysat required parameters
-platform = 'pysat'
+platform = 'missions'
 name = 'sgp4'
 # dictionary of data 'tags' and corresponding description
 tags = {'': 'Satellite simulation data set'}