Skip to content

Commit

Permalink
Merge branch 'master' into v/update-notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
VeckoTheGecko committed Jul 23, 2024
2 parents d84d09e + 035159a commit fc4aaf1
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 12 deletions.
1 change: 0 additions & 1 deletion .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ defaults:

jobs:
integration-test:
if: github.event.pull_request.draft == false
name: ${{ matrix.os }} integration tests
runs-on: ${{ matrix.os }}-latest
strategy:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ out-*
*.pyc
*.dSYM/*
**/*.zarr/*
.DS_store

.idea/*
.env
Expand Down
11 changes: 10 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@
r"https://github.com/OceanParcels/parcels/blob/daa4b062ed8ae0b2be3d87367d6b45599d6f95db/parcels/.*", # ignore GitHub anchors to blobs because of https://github.com/sphinx-doc/sphinx/issues/6779
]

# Define the canonical URL using custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand Down Expand Up @@ -152,7 +161,7 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
html_title = "Parcels Documentation"

# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
Expand Down
12 changes: 3 additions & 9 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,8 @@ The steps below are the installation instructions for Linux, macOS and Windows.
.. code-block:: bash
conda activate base
conda install -n base conda-libmamba-solver
conda config --set solver libmamba
conda create -n parcels -c conda-forge parcels cartopy jupyter
.. note::

The second and third line are temporarily needed to select the latest version 3.0 of Parcels. This will be fixed in the next release of conda. See `here <https://www.anaconda.com/blog/a-faster-conda-for-a-growing-community>`_ for more background information.

.. note::

For some of the examples, ``pytest`` also needs to be installed. This can be quickly done with ``conda install -n parcels pytest`` which installs ``pytest`` directly into the newly created ``parcels`` environment.
Expand Down Expand Up @@ -68,17 +62,17 @@ If you would prefer to have a development installation of Parcels (i.e., where t

**Step 1:** Same as `step 1 above`_.

**Step 2:** Clone the Parcels repo and create a new environment with the dependencies:
**Step 2:** Clone the Parcels repo and create a new environment with the development dependencies:

.. code-block:: bash
git clone https://github.com/OceanParcels/parcels.git
cd parcels
conda env create -f environment.yml
conda env create -n parcels-dev -f environment.yml
**Step 3:** Activate the environment and install Parcels in editable mode:

.. code-block:: bash
conda activate parcels
conda activate parcels-dev
pip install --no-build-isolation --no-deps -e .
2 changes: 1 addition & 1 deletion parcels/particledata.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def partitionParticlesMPI_default(coords, mpi_size=1):
else: # assigning random labels if no KMeans (see https://github.com/OceanParcels/parcels/issues/1261)
logger.warning_once('sklearn needs to be available if MPI is installed. '
'See https://docs.oceanparcels.org/en/latest/installation.html#installation-for-developers for more information')
mpiProcs = np.randint(0, mpi_size, size=coords.shape[0])
mpiProcs = np.random.randint(0, mpi_size, size=coords.shape[0])

return mpiProcs

Expand Down

0 comments on commit fc4aaf1

Please sign in to comment.