Skip to content

Commit

Permalink
minor update to install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnVolk committed Jul 26, 2024
1 parent 9d5b98e commit d41ad9c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ To activate the environment before using ``gridwxcomp`` run
$ conda activate gridwxcomp
Optionally, install using `pip <https://pip.pypa.io/en/stable/installing/>`_,
After installing all the dependencies using conda, install ``gridwxcomp`` using `pip <https://pip.pypa.io/en/stable/installing/>`_,

.. code-block:: bash
$ pip install gridwxcomp
Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment.
Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment. This is because the package includes several modules that are not pure Python such as GDAL and pyproj which seem to be better handled by conda.

Alternatively, or if there are installation issues, you can manually install. First activate the ``gridwxcomp`` conda environment (above). Next, clone or download the package from `GitHub <https://github.com/WSWUP/gridwxcomp>`_ or `PyPI <https://pypi.org/project/gridwxcomp/>`_ and then install locally with pip in "editable" mode. For example with cloning,

Expand Down
4 changes: 2 additions & 2 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ To activate the environment before using ``gridwxcomp`` run
$ conda activate gridwxcomp
Optionally, install using `pip <https://pip.pypa.io/en/stable/installing/>`_,
After installing all the dependencies using conda, install ``gridwxcomp`` using `pip <https://pip.pypa.io/en/stable/installing/>`_,

.. code-block:: bash
$ pip install gridwxcomp
Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment.
Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment. This is because the package includes several modules that are not pure Python such as GDAL and pyproj which seem to be better handled by conda.

Alternatively, or if there are installation issues, you can manually install. First activate the ``gridwxcomp`` conda environment (above). Next, clone or download the package from `GitHub <https://github.com/WSWUP/gridwxcomp>`_ or `PyPI <https://pypi.org/project/gridwxcomp/>`_ and then install locally with pip in "editable" mode. For example with cloning,

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
bokeh==3.4.1
earthengine_api==0.1.398
fiona==1.9.6
fiona
GDAL
geopandas==0.14.3
numpy==1.26.4
Expand Down

0 comments on commit d41ad9c

Please sign in to comment.