Skip to content

docs(readme): update core/optional dependencies #2019

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 26, 2023
Merged

docs(readme): update core/optional dependencies #2019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .docs/md/optional_dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Optional dependencies

Additional dependencies to use optional FloPy helper methods are listed below. These may be installed with `pip install flopy[optional]`.
Dependencies for optional features are listed below. These may be installed with `pip install flopy[optional]`.

| Method | Python Package |
|:-------------------------------------------------------------------------------------|:-------------------------------------------------------------------------|
Expand Down
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,17 @@ Documentation
Installation
-----------------------------------------------

FloPy requires **Python** 3.8 (or higher), **NumPy** 1.15.0 (or higher), and **matplotlib** 1.4.0 (or higher). Dependencies for optional FloPy methods are summarized [here](.docs/optional_dependencies.md).
FloPy requires **Python** 3.8+ with:

To install FloPy type:
```
numpy >=1.15.0
matplotlib >=1.4.0
pandas >=2.0.0
```

Dependencies for optional features are summarized [here](.docs/optional_dependencies.md).

To install type:

conda install -c conda-forge flopy

Expand All @@ -47,9 +55,9 @@ The release candidate version can also be installed from the git repository usin

After FloPy is installed, MODFLOW and related programs can be installed using the command:

get-modflow :flopy
get-modflow :

See [documentation](.docs/md/get_modflow.md) for more information.
See the [docs](.docs/md/get_modflow.md) for more information.


Getting Started
Expand Down