Skip to content

Commit fbbfecc

Browse files
authored
Documentation Changes (#272)
* updated docs and readme to point to conda-forge installation for now on * inserted NAIF Python Lessons into the docs with minimal modification * replacing some function links to sphinx compatable links * updated copyright
1 parent 632271e commit fbbfecc

26 files changed

+8450
-35
lines changed

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

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

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: README.rst

+17-5
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,23 @@ about SpiceyPy, usership, and how it works please cite my 2017 abstract, availab
4646
Installation
4747
------------
4848

49-
First install the dependencies (numpy, six, pytest) for the project. Then
50-
run ``pip install spiceypy`` to install from pypi.
51-
52-
SpiceyPy is also available through conda by either first installing pip via conda or by running
53-
``conda install -c https://conda.anaconda.org/andrewannex spiceypy``.
49+
+----------------+-------------------+
50+
| PyPI | Conda Forge |
51+
+================+===================+
52+
| |PyPI| | |Conda Version| |
53+
+----------------+-------------------+
54+
55+
.. |PyPI| image:: https://img.shields.io/pypi/v/spiceypy.svg
56+
:target: https://pypi.org/project/spiceypy/
57+
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/spiceypy.svg
58+
:target: https://anaconda.org/conda-forge/spiceypy
59+
60+
SpiceyPy can be installed using pip by running:
61+
``pip install spiceypy``
62+
63+
Anaconda users should use the conda-forge distribution of SpiceyPy by running:
64+
``conda config --add channels conda-forge``
65+
``conda install spiceypy``
5466

5567
If you wish to install spiceypy from source first download or clone the project. Then run ``python setup.py install``.
5668
To uninstall run ``pip uninstall spiceypy``.

0 commit comments

Comments
 (0)