Commit bc1c8240 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

The geoarray package is now on conda-forge! Updated the installation...


The geoarray package is now on conda-forge! Updated the installation instructions accordingly. Updated version info.

Signed-off-by: Daniel Scheffler's avatarDaniel Scheffler <danschef@gfz-potsdam.de>
parent 29a406ee
Pipeline #14727 passed with stages
in 47 seconds
......@@ -16,7 +16,7 @@ test_geoarray:
# update py_tools_ds
# - pip install "py_tools_ds>=0.14.36"
- conda install -c conda-forge cartopy # FIXME Remove as soon as docker container is rebuit
- conda install -c conda-forge cartopy # FIXME Remove as soon as docker container is rebuilt
# run tests
- make nosetests
......@@ -54,7 +54,7 @@ test_geoarray_install:
# create test environment
- conda create -y -q -c conda-forge --name geoarray_testinstall python=3
- source activate geoarray_testinstall
- conda activate geoarray_testinstall
# avoid package incompatibilities due to usage of wrong channels
# - conda config --set channel_priority strict # otherwise gdal or libgdal may be installed from defaults channel
......
......@@ -2,11 +2,14 @@
History
=======
0.10.0 (coming soon)
--------------------
0.10.0 (2020-10-19)
-------------------
* Added 'flag' parameter to GeoArray.calc_nodata_mask() + tests.
* Fixed type hints and some issues in test_geoarray.py.
* The geoarray package is now on conda-forge! Updated the installation instructions accordingly.
* Revised environment_geoarray.yml
* Replaced deprecated 'source activate' by 'conda activate'.
0.9.3 (2020-10-12)
......
......@@ -33,6 +33,8 @@ Status
:target: https://danschef.gitext-pages.gfz-potsdam.de/geoarray/coverage/
.. image:: https://img.shields.io/pypi/v/geoarray.svg
:target: https://pypi.python.org/pypi/geoarray
.. image:: https://img.shields.io/conda/vn/conda-forge/geoarray.svg
:target: https://anaconda.org/conda-forge/geoarray
.. image:: https://img.shields.io/pypi/l/geoarray.svg
:target: https://gitext.gfz-potsdam.de/danschef/geoarray/blob/master/LICENSE
.. image:: https://img.shields.io/pypi/pyversions/geoarray.svg
......@@ -52,34 +54,64 @@ Features and usage
Installation
------------
geoarray depends on some open source packages which are usually installed without problems by the automatic install
routine. However, for some projects, we strongly recommend resolving the dependency before the automatic installer
is run. This approach avoids problems with conflicting versions of the same software.
Using conda_, the recommended approach is:
.. code-block:: console
Using Anaconda or Miniconda (recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
# create virtual environment for geoarray, this is optional
conda create -c conda-forge --name geoarray python=3
source activate geoarray
conda install -c conda-forge numpy gdal scikit-image matplotlib pandas pyproj cartopy shapely geopandas
conda install -c conda-forge holoviews # optional, in case you want to use interactive plotting
Using conda_ (latest version recommended), geoarray is installed as follows:
To install geoarray, use the pip installer:
1. Create virtual environment for geoarray (optional but recommended):
.. code-block:: console
.. code-block:: bash
pip install geoarray
$ conda create -c conda-forge --name geoarray python=3
$ conda activate geoarray
* Or clone the repository via GIT and update the PATH environment variable:
2. Then install geoarray itself:
.. code-block:: console
.. code-block:: bash
cd /your/installation/folder
git clone https://gitext.gfz-potsdam.de/danschef/geoarray.git
PATH=$PATH:~/path/to/your/installation/folder/geoarray
$ conda install -c conda-forge geoarray
This is the preferred method to install geoarray, as it always installs the most recent stable release and
automatically resolves all the dependencies.
Using pip (not recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
There is also a `pip`_ installer for geoarray. However, please note that geoarray depends on some
open source packages that may cause problems when installed with pip. Therefore, we strongly recommend
to resolve the following dependencies before the pip installer is run:
* cartopy
* gdal >=2.1.0
* geopandas
* holoviews # optional, in case you want to use interactive plotting
* matplotlib
* numpy
* pandas
* pyproj >2.2.0
* scikit-image
* shapely
Then, the pip installer can be run by:
.. code-block:: bash
$ pip install geoarray
If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process.
History / Changelog
-------------------
You can find the protocol of recent changes in the geoarray package
`here <https://gitext.gfz-potsdam.de/danschef/geoarray/-/blob/master/HISTORY.rst>`__.
Credits
......@@ -93,3 +125,5 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
.. _nosetests: https://danschef.gitext-pages.gfz-potsdam.de/geoarray/nosetests_reports/nosetests.html
.. _conda: https://conda.io/docs/
.. _here: examples/notebooks/features_and_usage.ipynb
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
......@@ -20,5 +20,5 @@
# with this program. If not, see <http://www.gnu.org/licenses/>.
__version__ = '0.9.3'
__versionalias__ = '20201012.01'
__version__ = '0.10.0'
__versionalias__ = '20201019.01'
......@@ -7,5 +7,5 @@ COPY *.yml /root/
RUN /bin/bash -i -c "\
source /root/miniconda3/bin/activate ; \
conda update -n base -c conda-forge conda;\
source activate ci_env; \
conda activate ci_env; \
conda env update -n ci_env -f /root/environment_geoarray.yml"
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment