Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG/STY: update platform names #52

Merged
merged 4 commits into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion description.txt
Original file line number Diff line number Diff line change
@@ -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
-------------
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down
8 changes: 4 additions & 4 deletions docs/supported_instruments.rst
Original file line number Diff line number Diff line change
@@ -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:
16 changes: 8 additions & 8 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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)


Expand Down
4 changes: 2 additions & 2 deletions pysatMissions/instruments/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Properties
----------
platform
'pysat'
'missions'
name
'ephem'
tag
Expand All @@ -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'}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Properties
----------
platform
'pysat'
'missions'
name
'sgp4'
tag
Expand All @@ -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'}
Expand Down