Skip to content

Commit 032fb4a

Browse files
Merge pull request #8 from andersy005/patch-1
Update README
2 parents 3091b06 + d252f3e commit 032fb4a

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.rst

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,46 @@
1+
.. image:: https://img.shields.io/pypi/v/xlayers.svg?style=for-the-badge
2+
:target: https://pypi.org/project/xlayers
3+
:alt: Python Package Index
4+
5+
.. image:: https://img.shields.io/conda/vn/conda-forge/xlayers.svg?style=for-the-badge
6+
:target: https://anaconda.org/conda-forge/xlayers
7+
:alt: Conda Version
8+
9+
110
xlayers: Python implementation of MITgcm's layer package
211
========================================================
312

4-
xlayers requires the fortran-compiler package. Installing via `conda`_ is the easiest way::
13+
14+
15+
Installation
16+
------------
17+
18+
19+
xlayers can be installed from PyPI with pip:
20+
21+
.. code-block:: bash
22+
23+
python -m pip install xlayers
24+
25+
26+
It is also available from `conda-forge` for conda installations:
27+
28+
.. code-block:: bash
29+
30+
conda install -c conda-forge xlayers
31+
32+
To install xlayers from source repository, the fortran-compiler package is required. The easiest way to install the fortran-compiler is via `conda`_ :
33+
34+
.. code-block:: bash
535
636
conda install -c conda-forge fortran-compiler
737
unset LDFLAGS
838
939
.. _conda: https://conda-forge.org/
1040

11-
To install xlayers from Github::
41+
Once the compiler is installed, now we can install xlayers from Github:
42+
43+
.. code-block:: bash
1244
1345
git clone https://github.com/cspencerjones/xlayers.git
1446
cd xlayers

0 commit comments

Comments
 (0)