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

chore: improve optional dependencies in build #45

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions IS2view/utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ def import_dependency(
# PURPOSE: get the hash value of a file
def get_hash(
local: str | io.IOBase | pathlib.Path,
algorithm: str = 'MD5'
algorithm: str = 'md5'
):
"""
Get the hash value from a local file or ``BytesIO`` object
Expand All @@ -130,7 +130,7 @@ def get_hash(
----------
local: obj, str or pathlib.Path
BytesIO object or path to file
algorithm: str, default 'MD5'
algorithm: str, default 'md5'
hashing algorithm for checksum validation
"""
# check if open file object or if local file exists
Expand Down
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ prune doc*
prune notebooks*
exclude *.cfg
exclude *.yml
include requirements.txt
include version.txt
40 changes: 39 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,39 @@ Interactive visualization and data extraction tool for ICESat-2 ATL14/15 Gridded
- https://icesat-2-scf.gsfc.nasa.gov
- https://nsidc.org/data/icesat-2/

For more information: see the documentation at `is2view.readthedocs.io <https://is2view.readthedocs.io/>`_

Installation
############

From PyPI:

.. code-block:: bash

python3 -m pip install IS2view

To include all optional dependencies:

.. code-block:: bash

python3 -m pip install IS2view[all]

Using `conda` or `mamba` from conda-forge:

.. code-block:: bash

conda install -c conda-forge is2view

.. code-block:: bash

mamba install -c conda-forge is2view

Development version from GitHub:

.. code-block:: bash

python3 -m pip install git+https://github.com/tsutterley/IS2view.git

Dependencies
############

Expand All @@ -53,10 +86,15 @@ Download
| A zip archive of the latest version is available directly at:
| https://github.com/tsutterley/IS2view/archive/main.zip

Contributing
############

This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/IS2view/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.

Disclaimer
##########

This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
This program is not sponsored or maintained by the Universities Space Research Association (USRA) or NASA.
It is provided here for your convenience but *with no guarantees whatsoever*.

Expand Down
8 changes: 4 additions & 4 deletions doc/source/getting_started/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ To use the development repository, please fork ``IS2view`` into your own account

git clone https://github.com/tsutterley/IS2view.git

``IS2view`` can then be installed within the package directory using ``setuptools``:
``IS2view`` can then be installed within the package directory using ``pip``:

.. code-block:: bash

python3 setup.py install
python3 -m pip install --user .

or ``pip``
To include all optional dependencies:

.. code-block:: bash

python3 -m pip install --user .
python3 -m pip install --user .[all]

The development version of ``IS2view`` can also be installed directly from GitHub using ``pip``:

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Issues = "https://github.com/tsutterley/IS2view/issues"

[project.optional-dependencies]
doc = ["docutils", "graphviz", "ipywidgets", "notebook", "numpydoc", "sphinx", "sphinx-argparse>=0.4", "sphinx_rtd_theme"]
all = ["ipywidgets", "notebook"]
all = ["boto3", "bottleneck", "dask", "geopandas", "ipywidgets", "notebook", "owslib", "s3fs", "xyzservices", "zarr"]
dev = ["flake8", "pytest>=4.6", "pytest-cov"]

[tool.setuptools.packages.find]
Expand Down