Skip to content

Commit

Permalink
need to install esmpy via conda first
Browse files Browse the repository at this point in the history
  • Loading branch information
jmineau committed Aug 29, 2024
1 parent 3692878 commit d2bf70b
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 8 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,34 @@

# Installation

`lair` can be installed via `pip`:
The `lair` package is installable from the git repository via `pip`, however, some dependencies can only be installed via `conda`.
Additionally, many components of `lair` require access to CHPC which encourages the use of `conda`. Therefore, we recommend using `conda` to install the package.

> If you are using CHPC, it is assumed that `miniforge3` is installed following the instructions at https://www.chpc.utah.edu/documentation/software/python-anaconda.php
To create a new conda environment for `lair`, use the following command:

```bash
mamba create -n lair -c conda-forge python=3.10 esmpy
```

If you already have a conda environment, simply install the dependencies:

```bash
mamba activate <lair-env>
mamba install -c conda-forge esmpy
```

> `lair` requires Python 3.10 or higher.
Now we can install the package via `pip`. Either directly from the git repository:

```bash
pip install git+https://github.com/jmineau/lair.git
```

or by cloning the repository and installing it as an editable package:

```bash
git clone https://github.com/jmineau/lair.git
cd lair
Expand All @@ -36,8 +58,6 @@ The following modules are impacted:
- `lair.air.hrrr`
- `lair.air.soundings`

### Installing Optional Dependencies

To install the optional dependencies, use the following command:

```bash
Expand Down
31 changes: 26 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,31 @@ UATAQ project.
Installation
============

``lair`` can be installed via ``pip``:
The ``lair`` package is installable from the git repository via ``pip``, however, some dependencies can only be installed via ``conda``.
Additionally, many components of ``lair`` require access to CHPC which encourages the use of ``conda``. Therefore, we recommend using ``conda`` to install the package.

.. important::

If you are using CHPC, it is assumed that ``miniforge3`` is installed following the instructions at https://www.chpc.utah.edu/documentation/software/python-anaconda.php

To create a new conda environment for ``lair``, use the following command:

.. code-block:: bash
mamba create -n lair -c conda-forge python=3.10 esmpy
If you already have a conda environment, simply install the dependencies:

.. code-block:: bash
mamba activate <lair-env>
mamba install -c conda-forge esmpy
.. note::

``lair`` requires Python 3.10 or higher.

Now we can install the package via ``pip``. Either directly from the git repository:

.. code-block:: bash
Expand All @@ -79,7 +103,7 @@ or by cloning the repository and installing it as an editable package:
pip install -e .
Optional Dependencies
^^^^^^^^^^^^^^^^^^^^^
---------------------

``lair`` is a rather dependecy-heavy package, however, many are common in the field of atmospheric science. To keep ``lair`` as lightweight as possible, some dependencies related to meteorology are currently optional. These include:

Expand All @@ -95,9 +119,6 @@ The following modules are impacted:
- ``lair.air.hrrr``
- ``lair.air.soundings``

Installing Optional Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To install the optional dependencies, use the following command:

.. code-block:: bash
Expand Down

0 comments on commit d2bf70b

Please sign in to comment.