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

Tj docs #89

Merged
merged 3 commits into from
Jun 24, 2020
Merged
Show file tree
Hide file tree
Changes from 2 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
34 changes: 27 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,44 @@ This project combines and generalizes these scripts into a unified framework, ma


.. _`zipped file`: https://github.com/icesat2py/icepyx/archive/master.zip
.. _`Fiona`: https://pypi.org/project/Fiona/

Installation
------------
Currently icepyx is only available for use as a github repository.
The contents of the repository can be download as a `zipped file`_ or cloned.
The simplest way to install icepyx is using pip.

To use icepyx, fork this repo to your own account, then ``git clone`` the repo onto your system.
Provided the location of the repo is part of your $PYTHONPATH,
you should simply be able to add ``import icepyx`` to your Python document.
.. code-block::

pip install icepyx


Windows users will need to first install `Fiona`_, please look at the instructions there. Windows users may consider installing Fiona using pipwin

.. code-block::

pip install pipwin
pipwin install Fiona


Currently, packages are not automatically generated with each build, this means it is possible that pip will not install the latest release of icepyx. In this case, icepyx is also available for use via the GitHub repository. The contents of the repository can be download as a `zipped file`_ or cloned.

To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system.
To clone the repository:

.. code-block:: none
.. code-block::

git clone https://github.com/icesat2py/icepyx.git


Future developments of icepyx may include pip and conda as simplified installation options.
Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add import icepyx to your Python document.
Alternatively, in a command line or terminal, navigate to the folder in your cloned repository containing setup.py and run

.. code-block::

pip install -e


Future developments of icepyx may include conda as another simplified installation option.


Examples (Jupyter Notebooks)
Expand Down
32 changes: 24 additions & 8 deletions doc/source/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,45 @@


.. _`zipped file`: https://github.com/icesat2py/icepyx/archive/master.zip

.. _`Fiona`: https://pypi.org/project/Fiona/




Installation
============

The simplest way to install icepyx is using pip.

.. code-block::

pip install icepyx


Windows users will need to first install `Fiona`_, please look at the instructions there. Windows users may consider installing Fiona using pipwin

Currently icepyx is only available for use as a github repository.
The contents of the repository can be download as a `zipped file`_ or cloned.
.. code-block::

To use icepyx, fork this repo to your own account, then ``git clone`` the repo onto your system.
Provided the location of the repo is part of your $PYTHONPATH,
you should simply be able to add ``import icepyx`` to your Python document.
pip install pipwin
pipwin install Fiona


Currently, packages are not automatically generated with each build, this means it is possible that pip will not install the latest release of icepyx. In this case, icepyx is also available for use via the GitHub repository. The contents of the repository can be download as a `zipped file`_ or cloned.

To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system.
To clone the repository:

.. code-block:: none
.. code-block::

git clone https://github.com/icesat2py/icepyx.git


Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add import icepyx to your Python document.
Alternatively, in a command line or terminal, navigate to the folder in your cloned repository containing setup.py and run

.. code-block::

pip install -e


Future developments of icepyx may include pip and conda as simplified installation options.
Future developments of icepyx may include conda as another simplified installation option.