Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewAnnex committed Jul 31, 2015
1 parent f65ec9b commit 354862d
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Please visit the NAIF website listed earlier for more details.
### Travis and Coveralls Status

[![Build Status](https://travis-ci.org/AndrewAnnex/SpiceyPy.svg?style=flat?branch=master)](https://travis-ci.org/AndrewAnnex/SpiceyPy)
[![Windows Build status](https://ci.appveyor.com/api/projects/status/wly0q2cwy33ffura/branch/master?svg=true)](https://ci.appveyor.com/project/AndrewAnnex/spiceypy/branch/master)
[![Coverage Status](https://img.shields.io/coveralls/AndrewAnnex/SpiceyPy.svg)](https://coveralls.io/r/AndrewAnnex/SpiceyPy?branch=master)
A secondary list (non-maintained) of what functions have been wrapped can be found [here](https://github.com/AndrewAnnex/SpiceyPy/wiki/Wrapper-Completion).
A majority of SPICE functions have written wrappers along with tests mainly derived from the CSPICE documentation.
Expand Down Expand Up @@ -47,24 +48,32 @@ The citation information for SPICE can be found on the NAIF website and please c

### Design Goals
- [x] Majorly complete coverage of all existing CSPICE commands, within reason.
- [ ] Useful, but abbreviated commenting on functions.
- [ ] Enable vectorization of certain functions to be more like ICY.
- [x] Useful, but abbreviated commenting on functions.
- [x] Python 2 and 3 support.
- [x] Numpy Support.
- [ ] Enable vectorization of certain functions to be more like ICY.

### Installation
First install the dependencies (numpy, six, pytest). Then download the project, extract it, and inside just run `python setup.py install`.
If you are updating to the newest commit/version, be sure to completely delete the SpiceyPy folder in your site-packages.
This can most commonly be done by uninstalling SpiceyPy using pip.

### Known Working Environments:
These are the following OS environments I have been able to run the exampleProgramTest.py program on. SpiceyPy is being developed
in a Python 3.4.1 64-bit Mac OS X 10.9.5 environment. Travis CI is also ubuntu 12.04 LTS to my knowledge.
These are the following OS environments with all tests passing. SpiceyPy is being developed
in a Python 3.4.1 64-bit Mac OS X 10.10.4 environment. Travis CI is ubuntu 12.04 LTS to my knowledge.
* Python 3.4.1 64-bit Mac OS X 10.10.4
* Python 3.3.3 64-bit Mac OS X 10.9.4
* Python 2.7.5 64-bit Mac OS X 10.9.4
* Python 3.3.3 64-bit Mac OS X 10.9.2
* Python 2.7.5 64-bit Mac OS X 10.9.2
* Python 3.2.3 64-bit Ubuntu 12.04 LTS (VM)
* _Python 3.4.3 64-bit Windows (Appveyor), using Visual Studio 2013_
* _Python 2.7.9 64-bit Windows (Appveyor), using Visual Studio 2013_

#### Windows Support
Windows support is currently highly experimental and difficult for the author to test locally.
If attempting to install on windows platforms, please ensure you have a recent version of Visual Studio is
installed and ensure cl.exe and link.exe is available on the path.

### Acknowledgements
[DaRasch](https://github.com/DaRasch) wrote spiceminer, which I looked at to get SpiceCells working, thanks!
Expand Down

0 comments on commit 354862d

Please sign in to comment.