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

Made h5py a required dependency #63

Merged
merged 3 commits into from
May 27, 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
11 changes: 6 additions & 5 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ the installation is in principle as simple as running
pip install py-droplets


In order to have all features of the package available, you might also want to
In order to have all features of the package available, you might also want to
install the following optional packages:

.. code-block:: bash

pip install h5py pyfftw
pip install h5py pyfftw


Installing from source
Expand All @@ -35,13 +35,14 @@ The code builds on other python packages, which need to be installed for
The required packages are listed in the table below:

=========== ========= =========
Package Version Usage
Package Version Usage
=========== ========= =========
h5py >=2.10 Reading and writing data
matplotlib >=3.1 Visualizing results
numpy >=1.22 Array library used for storing data
numba >=0.59 Just-in-time compilation to accelerate numerics
scipy >=1.4 Miscellaneous scientific functions
py-pde >=0.37 Simulating partial differential equations
py-pde >=0.39 Simulating partial differential equations
=========== ========= =========

These package can be installed via your operating system's package manager, e.g.
Expand All @@ -53,7 +54,7 @@ latest version of the package.
The `py-pde` package is available on `pip`, but if this is inconvenient the
package can also be installed from github sources, as `described in its
documentation
<https://py-pde.readthedocs.io/en/latest/installation.html#installing-from-source>`_.
<https://py-pde.readthedocs.io/en/latest/installation.html#installing-from-source>`_

A small subset of the package will only be available if extra optional packages are
installed. Currently, this only concerns the `h5py` package for reading hdf files.
Expand Down
6 changes: 2 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,14 @@ classifiers = [

# Requirements for setuptools
dependencies = [
"h5py>=2.10",
"matplotlib>=3.1",
"numba>=0.59",
"numpy>=1.22",
"scipy>=1.4",
"py-pde>=0.37",
"py-pde>=0.39",
]

[project.optional-dependencies]
hdf = ["h5py>=2.10"]

[project.urls]
homepage = "https://github.com/zwicker-group/py-droplets"
documentation = "http://py-droplets.readthedocs.io"
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
h5py>=2.10
matplotlib>=3.1
numpy>=1.22
numba>=0.59
scipy>=1.4
py-pde>=0.37
py-pde>=0.39
1 change: 0 additions & 1 deletion tests/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-r ../requirements.txt
black>=24.*
h5py
isort>=5.1
pyupgrade>=3
pytest>=5.4
Expand Down
Loading