Skip to content

Commit 6987f89

Browse files
Changing indentation of code-blocks in installation instruction
Removing the 'double-block' for code in a list, that seems to be a bug in sphinx-docs? Now also more control on the numbering of items Also updating some of the texts
1 parent 3f432ad commit 6987f89

File tree

1 file changed

+29
-24
lines changed

1 file changed

+29
-24
lines changed

docs/installation.rst

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,56 @@
11
Basic installation
22
==================
33

4-
The simplest way to install the Parcels code is to use Anaconda and the `Parcels conda-forge package <https://anaconda.org/conda-forge/parcels>`_ with the latest release of Parcels. This package will automatically install all the requirements for a fully functional installation of Parcels. This is the “batteries-included” solution probably suitable for most users. If you want to install the latest development version of Parcels and work with features that have not yet been officially released, you can follow the instructions for a `developer installation <#installation-for-developers>`_.
4+
The simplest way to install the Parcels code is to use Anaconda and the `Parcels conda-forge package <https://anaconda.org/conda-forge/parcels>`_ with the latest release of Parcels. This package will automatically install all the requirements for a fully functional installation of Parcels. This is the “batteries-included” solution probably suitable for most users.
55

6-
The steps below are the installation instructions for Linux / macOS and for Windows. If the commands for Linux / macOS and Windows differ, this is indicated with a comment at the end of the line.
6+
If you want to install the latest development version of Parcels and work with features that have not yet been officially released, you can follow the instructions for a `developer installation <#installation-for-developers>`_.
77

8-
#. Install Anaconda's Miniconda following the steps at https://conda.io/docs/user-guide/install/, making sure to select the Python-3 version. If you're on Linux /macOS, it also assumes that you installed Miniconda-3 to your home directory.
8+
The steps below are the installation instructions for Linux, macOS and Windows.
99

10-
#. Start a terminal (Linux / macOS) or the Anaconda prompt (Windows). Activate the ``base`` environment of your Miniconda and create an environment containing Parcels, all its essential dependencies, and the nice-to-have cartopy and jupyter packages:
10+
**Step 1:** Install Anaconda's Miniconda following the steps at https://conda.io/docs/user-guide/install/, making sure to select the Python-3 version. If you're on Linux /macOS, the following assumes that you installed Miniconda to your home directory.
1111

12-
.. code-block:: bash
12+
**Step 2:** Start a terminal (Linux / macOS) or the Anaconda prompt (Windows). Activate the ``base`` environment of your Miniconda and create an environment containing Parcels, all its essential dependencies, and the nice-to-have cartopy and jupyter packages:
1313

14-
conda activate base
15-
conda create -n parcels -c conda-forge parcels cartopy
14+
.. code-block:: bash
15+
16+
conda activate base
17+
conda create -n parcels -c conda-forge parcels cartopy jupyter
1618
17-
.. note::
19+
.. note::
1820

19-
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.
21+
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.
2022

21-
#. Activate the newly created Parcels environment:
23+
**Step 3:** Activate the newly created Parcels environment:
2224

23-
.. code-block:: bash
25+
.. code-block:: bash
2426
25-
conda activate parcels
27+
conda activate parcels
2628
27-
#. Download `a zipped copy <https://docs.oceanparcels.org/en/latest/_downloads/307c382eb1813dc691e8a80d6c0098f7/parcels_tutorials.zip>`_ of the Parcels tutorials and examples and unzip it.
29+
**Step 4:** Download `a zipped copy <https://docs.oceanparcels.org/en/latest/_downloads/307c382eb1813dc691e8a80d6c0098f7/parcels_tutorials.zip>`_ of the Parcels tutorials and examples and unzip it.
2830

29-
#. Go to the unzipped folder and run one of the examples to validate that you have a working Parcels setup:
31+
**Step 5:** Go to the unzipped folder and run one of the examples to validate that you have a working Parcels setup:
3032

31-
.. code-block:: bash
33+
.. code-block:: bash
3234
33-
python example_peninsula.py --fieldset 100 100
35+
python example_peninsula.py --fieldset 100 100
3436
35-
.. note::
36-
If you are on macOS and get a compilation error, you may need to accept the Apple xcode license ``xcode-select --install``. If this does not solve the compilation error, you may want to try running ``export CC=gcc``. If the compilation error remains, you may want to check `this solution <https://stackoverflow.com/a/58323411/5172570>`_.
37+
.. note::
38+
If you are on macOS and get a compilation error, you may need to accept the Apple xcode license ``xcode-select --install``. If this does not solve the compilation error, you may want to try running ``export CC=gcc``. If the compilation error remains, you may want to check `this solution <https://stackoverflow.com/a/58323411/5172570>`_.
39+
40+
*Optionally:* if you want to run all the examples and tutorials, start Jupyter and open the tutorial notebooks:
41+
42+
.. code-block:: bash
3743
38-
#. Optionally, if you want to run all the examples and tutorials, start Jupyter and open the tutorial notebooks:
44+
jupyter notebook
3945
40-
.. code-block:: bash
4146
42-
jupyter notebook
47+
.. note::
4348

44-
#. The next time you start a terminal and want to work with Parcels, activate the environment with:
49+
The next time you start a terminal and want to work with Parcels, activate the environment with:
4550

46-
.. code-block:: bash
51+
.. code-block:: bash
4752
48-
conda activate parcels
53+
conda activate parcels
4954
5055
5156
Installation for developers

0 commit comments

Comments
 (0)