Merge pull request #5 from pysat/develop

v0.1.0

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+
+[report]
+omit =
+  */tests/*

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+ - Other details about your setup that could be relevant
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,44 @@
+# Description
+
+Addresses #(issue)
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context. List any dependencies that are required
+for this change.  Please see ``CONTRIBUTING.md`` for more guidelines.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality)
+- Breaking change (fix or feature that would cause existing functionality
+      to not work as expected)
+- This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce. Please also list any relevant details for
+your test configuration
+
+- Test A
+- Test B
+
+**Test Configuration**:
+* Operating system
+* Version number
+* Any details about your local setup that are relevant
+
+# Checklist:
+
+- [ ] Make sure you are merging into the ``develop`` (not ``master``) branch
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] Add a note to ``CHANGELOG.md``, summarizing the changes

.gitignore

@@ -0,0 +1,72 @@
+*~
+.DS_store
+
+# Python Repository Ignores as Recommended by github.com########################
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+.ipynb_checkpoints
+
+*.py#
+
+.*.swp
+typescript
+custom_lint.sh
+
+# IDEs
+.idea/

.travis.yml

@@ -0,0 +1,62 @@
+language: python
+dist: xenial
+matrix:
+  include:
+    - python: 2.7
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+
+services: xvfb
+addons:
+  apt:
+    packages:
+    - gfortran
+
+before_install:
+  - pip install pytest-cov
+  - pip install coveralls
+  - pip install future
+  - pip install matplotlib
+  - pip install apexpy
+
+  # Prepare modified pysat install
+  - pip install numpy
+  - cd ..
+  - echo 'cloning pysat'
+  - git clone https://github.com/pysat/pysat.git >/dev/null
+  - echo 'installing pysat'
+  - cd ./pysat
+  - git checkout no_sgp4
+  # set up data directory
+  - mkdir /home/travis/build/pysat/pysatData
+  # install pysat
+  - cd /home/travis/build/pysat/pysat
+  - python setup.py install >/dev/null
+
+  # install pyglow, space science models
+  - cd ..
+  - echo 'cloning pyglow'
+  - git clone https://github.com/timduly4/pyglow.git >/dev/null
+  - echo 'installing pyglow'
+  - cd ./pyglow
+  - make -C src/pyglow/models source >/dev/null
+  - python setup.py install >/dev/null
+  - cd /home/travis/build/pysat/pysatMissionPlanning
+
+install:
+  - python setup.py install
+
+before_script:
+  # set up display screen
+  - export DISPLAY=:99.0
+  - if [[ $TRAVIS_PYTHON_VERSION < "3.0" ]]; then
+      sh -e /etc/init.d/xvfb start;
+      sleep 3;
+    fi
+
+script:
+  - pytest -vs --cov=pysatMissionPlanning/
+
+after_success:
+  - coveralls

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2019-xx-xx
+- Initial release

CONTRIBUTING.md

@@ -0,0 +1,90 @@
+Contributing
+============
+
+Bug reports, feature suggestions and other contributions are greatly
+appreciated!  pysatMissionPlanning is a community-driven project and welcomes both feedback and contributions.
+
+Short version
+=============
+
+* Submit bug reports and feature requests at `GitHub <https://github.com/pysat/pysatMissionPlanning/issues>`_
+* Make pull requests to the ``develop`` branch
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/pysat/pysatMissionPlanning/issues>`_ please
+include:
+
+* Your operating system name and version
+* Any details about your local setup that might be helpful in troubleshooting
+* Detailed steps to reproduce the bug
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at
+`GitHub <https://github.com/pysat/pysatMissionPlanning/issues>`_.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions
+  are welcome :)
+
+Development
+===========
+
+To set up `pysatMissionPlanning` for local development:
+
+1. `Fork pysat on GitHub <https://github.com/pysat/pysatMissionPlanning/fork>`_.
+2. Clone your fork locally::
+
+    git clone [email protected]:your_name_here/pysatMissionPlanning.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally. Tests for new instruments are
+   performed automatically.  Tests for custom functions should be added to the
+   appropriately named file in ``pysatMissionPlanning/tests``.  For example, the averaging routines in avg.py are tested in ``pysatMissionPlanning/tests/test_avg.py``.  If no
+   test file exists, then you should create one.  This testing uses pytest, which
+   will run tests on any python file in the test directory that starts with
+   ``test_``.
+
+4. When you're done making changes, run all the checks to ensure that nothing
+   is broken on your local system::
+
+    pytest -vs
+
+5. Update/add documentation (in ``docs``), if relevant
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Brief description of your changes"
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website. Pull requests should be
+   made to the ``develop`` branch.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code, just
+make a pull request. Pull requests should be made to the ``develop`` branch.
+
+For merging, you should:
+
+1. Include an example for use
+2. Add a note to ``CHANGELOG.md`` about the changes
+3. Ensure that all checks passed (current checks include Scrutinizer, Travis-CI,
+   and Coveralls) [1]_
+
+.. [1] If you don't have all the necessary Python versions available locally or
+       have trouble building all the testing environments, you can rely on
+       Travis to run the tests for each change you add in the pull request.
+       Because testing here will delay tests by other developers, please ensure
+       that the code passes all tests on your local system first.

README.md

@@ -1 +1,48 @@
+<div align="left">
+        <img height="0" width="0px">
+        <img width="20%" src="/poweredbypysat.png" alt="pysat" title="pysat"</img>
+</div>
+
 # pysatMissionPlanning
+[![Build Status](https://travis-ci.org/pysat/pysatMissionPlanning.svg?branch=master)](https://travis-ci.org/pysat/pysatMissionPlanning)
+[![Coverage Status](https://coveralls.io/repos/github/pysat/pysatMissionPlanning/badge.svg?branch=master)](https://coveralls.io/github/pysat/pysatMissionPlanning?branch=master)
+
+pysatMissionPlanning 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.
+
+Main Features
+-------------
+- Simulate satellite orbits from TLEs and add data from empirical models
+- Import ionosphere and thermosphere values through pyglow
+- Import coordidnates through apexpy
+
+Documentation
+---------------------
+`Full Documentation for main package <http://pysat.readthedocs.io/en/latest/>`_
+
+
+# Installation
+
+First, checkout the repository:
+
+```
+  git clone https://github.com/pysat/pysatMissionPlanning.git
+```
+
+Change directories into the repository folder and run the setup.py file.  For
+a local install use the "--user" flag after "install".
+
+```
+  cd pysatMissionPlanning/
+  python setup.py install
+```
+
+# Using with pysat
+
+The module is portable and designed to be run like any pysat instrument.
+
+```
+import pysat
+from pysatMissionPlanning.instruments import pysat_sgp4
+
+sgp4 = pysat.Instrument(inst_module=pysat_sgp4)
+```

description.txt

@@ -0,0 +1,11 @@
+pysatMissionPlanning 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.
+
+Main Features
+-------------
+- Simulate satellite orbits from TLEs and add data from empirical models
+- Import ionosphere and thermosphere values through pyglow
+- Import coordidnates through apexpy
+
+Documentation
+---------------------
+`Full Documentation for main package <http://pysat.readthedocs.io/en/latest/>`_