From 35444ec47c55c9eaeff635a9c4f0a39bc673eca0 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Thu, 18 Jun 2020 19:07:15 +0100 Subject: [PATCH 1/2] Updated installation instructions --- README.rst | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 2b6d80f88..a24ea21e2 100644 --- a/README.rst +++ b/README.rst @@ -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) From 96bab86c4d547683b1a5310dfdbcdf0c9a3c6e49 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Thu, 18 Jun 2020 19:11:11 +0100 Subject: [PATCH 2/2] Changed installation instructions on readthedocs --- doc/source/getting_started/install.rst | 32 +++++++++++++++++++------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index 04cf021f7..9a596c094 100644 --- a/doc/source/getting_started/install.rst +++ b/doc/source/getting_started/install.rst @@ -2,7 +2,7 @@ .. _`zipped file`: https://github.com/icesat2py/icepyx/archive/master.zip - +.. _`Fiona`: https://pypi.org/project/Fiona/ @@ -10,21 +10,37 @@ 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.