Skip to content
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 docs/api/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ All notable changes to this project will be documented in this file.
The format is based on `Keep a Changelog`_, and this project adheres to
`Semantic Versioning`_.

[Unreleased]
------------
[1.1.0] - 2026-08-03
--------------------

Added
~~~~~
Expand Down
48 changes: 3 additions & 45 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ This section is for if you are in a hurry and just want to get started. We
advice you to read the full documentation below if you are new to Python or the
Python packaging ecosystem.

Regular install
^^^^^^^^^^^^^^^

Install with pixi::
Install with `pixi`_ (recommended)::

pixi add imod

Expand All @@ -23,45 +20,18 @@ Install with pip::

pip install imod

Install beta release
^^^^^^^^^^^^^^^^^^^^

To install a beta release with pixi::

pixi config prepend default-channels "conda-forge/label/imod_rc"
pixi add imod=1.0.0rc5

Or with conda::

conda install -c conda-forge/label/imod_rc -c conda-forge imod=1.0.0rc5

Or with pip::

pip install --pre imod=1.0.0rc5


Which Python?
-------------

You'll need **3.11, 3.12, or 3.13**.
You'll need **3.12, 3.13, or 3.14**.

The recommended way to install Python depends on your experience: Are you new to
the Python packaging ecosystem or already got experience with it? If you already
know what ``conda`` and ``pip`` are, and are able to install tedious packages
GIS packages yourself without issue, you are *experienced*. If you have no idea
what the previous sentence was about, you are *new*.

New
^^^

We recommend new users to install iMOD Python using the `Deltaforge`_ Python
distribution. See :ref:`install_deltaforge`.

Experienced
^^^^^^^^^^^

For experienced users, who want to be in control of packages installed, we
recommend installing using `pixi`_. Pixi supports creating reproducible
We recommend installing using `pixi`_. Pixi supports creating reproducible
projects, where all dependencies' versions in an environment are stored in a
textfile, the "lockfile". On top of that, it is faster than other package
managers.
Expand All @@ -84,18 +54,6 @@ installations in your system.
Ways to install iMOD Python
---------------------------

.. _install_deltaforge:

Installing with Deltaforge
^^^^^^^^^^^^^^^^^^^^^^^^^^

Deltaforge is an installer of Deltares python packages, including iMOD Python,
and their dependencies. This makes it possible to install iMOD Python without
much knowledge about the Python package management system. The download links
are listed `here. <https://deltares.github.io/deltaforge/index.html#where>`__
Users new to the python package ecosystem are recommended to install iMOD Python
using Deltaforge.

Installing with pixi
^^^^^^^^^^^^^^^^^^^^

Expand Down
6 changes: 3 additions & 3 deletions examples/user-guide/08-assign-wells.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Assigning Wells to Model Layers
==========
===============================

iMOD Python provides two grid-agnostic well classes:
:class:`imod.mf6.Well` and :class:`imod.mf6.LayeredWell`
Expand Down Expand Up @@ -62,7 +62,7 @@

# %%
# Create a Well object
# ------------
# --------------------
#
# Now that we have the model data and well data, we can create a :class:`imod.mf6.Well` object
# and convert it to a MODFLOW 6 well package input.
Expand Down Expand Up @@ -147,7 +147,7 @@

# %%
# Create a Layered Well object
# ------------
# ----------------------------
#
# Now we can follow a similar process to create a :class:`imod.mf6.LayeredWell` object
# and convert it to a MODFLOW 6 well package input. The process is the similar, except we
Expand Down
Loading
Loading