Skip to content

Commit

Permalink
Merge 69c05eb into 632271e
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewAnnex committed Aug 26, 2018
2 parents 632271e + 69c05eb commit 3cc4fe9
Show file tree
Hide file tree
Showing 27 changed files with 8,452 additions and 37 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) [2015-2017] [Andrew Annex]
Copyright (c) [2015-2018] [Andrew Annex]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 17 additions & 5 deletions README.rst
Expand Up @@ -46,11 +46,23 @@ about SpiceyPy, usership, and how it works please cite my 2017 abstract, availab
Installation
------------

First install the dependencies (numpy, six, pytest) for the project. Then
run ``pip install spiceypy`` to install from pypi.

SpiceyPy is also available through conda by either first installing pip via conda or by running
``conda install -c https://conda.anaconda.org/andrewannex spiceypy``.
+----------------+-------------------+
| PyPI | Conda Forge |
+================+===================+
| |PyPI| | |Conda Version| |
+----------------+-------------------+

.. |PyPI| image:: https://img.shields.io/pypi/v/spiceypy.svg
:target: https://pypi.org/project/spiceypy/
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/spiceypy.svg
:target: https://anaconda.org/conda-forge/spiceypy

SpiceyPy can be installed using pip by running:
``pip install spiceypy``

Anaconda users should use the conda-forge distribution of SpiceyPy by running:
``conda config --add channels conda-forge``
``conda install spiceypy``

If you wish to install spiceypy from source first download or clone the project. Then run ``python setup.py install``.
To uninstall run ``pip uninstall spiceypy``.
Expand Down
4 changes: 2 additions & 2 deletions docs/basics.rst
Expand Up @@ -37,7 +37,7 @@ explanitory error message.
A simple example program
------------------------

The following calls the SPICE function :py:meth:`spiceypy.spiceypy.tkvrsn` which outputs the version
The following calls the SPICE function :py:meth:`spiceypy.spiceypy.spiceypytkvrsn` which outputs the version
of cspice that SpiceyPy is wrapping.

.. code:: python
Expand All @@ -64,7 +64,7 @@ and traceback (of spice calls). `Read the NAIF tutorial on exceptions here. <htt

Also, by default SpiceyPy captures the 'found' flags some functions return as it is not
idiomatic to python and instead through a SpiceyError exception. This can be temporarily disabled using
the :py:meth:`spiceypy.spiceypy.no_found_check` context manager that allows the found
the :py:meth:`spiceypy.spiceypy.spiceypyno_found_check` context manager that allows the found
flag to be returned to the user for action. Outside the context SpiceyPy functions will revert to default behavior.

.. code:: python
Expand Down

0 comments on commit 3cc4fe9

Please sign in to comment.