File tree Expand file tree Collapse file tree 1 file changed +5
-41
lines changed Expand file tree Collapse file tree 1 file changed +5
-41
lines changed Original file line number Diff line number Diff line change @@ -24,58 +24,22 @@ suggestions.
2424 extending_xbout
2525 xbout
2626
27- Requirements
28- ------------
29-
30- - :py:mod: `xbout ` requires Python 3
31-
32- - The following modules are also needed:
33- - ``xarray >= v0.13.0 ``
34- - ``dask[array] >= 1.0.0 ``
35- - ``natsort >= 5.5.0 ``
36- - ``matplotlib >= 2.2 ``
37- - ``animatplot >= 0.4.0 ``
38- - ``netcdf4 >= 1.4.0 ``
39- - All dependencies can be installed by running:
40-
41- .. code-block :: bash
42-
43- pip3 install --user -r requirements.txt
44-
45-
4627Installation
4728------------
4829
49- - :py:mod: `xbout ` is not currently on pip or conda. Therefore to install xbout on
50- your system you must first clone the repository using:
51-
52- .. code-block :: bash
53-
54- git clone [email protected] :boutproject/xBOUT.git 55-
56- or
30+ With `pip `:
5731
5832.. code-block :: bash
5933
60- git clone https://github.com/boutproject/xBOUT.git
34+ pip install --user xbout
6135
62-
63- Once cloned navigate to the `xBOUT ` directory and run the following command:
36+ or `conda `:
6437
6538.. code-block :: bash
6639
67- pip3 install --user ./
68-
69- or
70-
71- .. code-block :: bash
72-
73- python3 setup.py install
74-
40+ conda install xbout
7541
76- You can run the tests by navigating to the `/xBOUT/ ` directory and
77- entering `pytest `. You can also test your installation of `xBOUT ` by
78- running `pytest --pyargs xbout `.
42+ You can run the tests by running `pytest --pyargs xbout `.
7943
8044xBOUT will install the required python packages when you run one of
8145the above install commands if they are not already installed on your
You can’t perform that action at this time.
0 commit comments