update conda install to conda create #294
Conversation
Hopefully this path will avoid some of the dependency issues experienced by Mike W on perlmutter
There was a problem hiding this comment.
Hi @durack1, thanks for this PR!
I think we should keep in the single line command for installing xcdat in existing environments, in addition to creating conda environments from scratch with xcdat. Most conda packages usually list conda install in existing environments, with the assumption that you know how to build conda environments.
Here's the installation example on xarray: https://docs.xarray.dev/en/stable/getting-started-guide/installing.html#instructions
Xarray itself is a pure Python package, but its dependencies are not. The easiest way to get everything installed is to use conda. To install xarray with its recommended dependencies using the conda command line tool:
$ conda install -c conda-forge xarray dask netCDF4 bottleneck
docs/getting-started.rst
Outdated
| Installation | ||
| ------------ | ||
|
|
||
| To install ``xcdat`` using `conda`_, run: | ||
| We recommend using the anaconda environment creation procedure to install ``xcdat``. The advantage of following this approach, is that any dependencies (e.g. ``python >= 3.8``) will be resolved during the environment creation. To proceed, run: | ||
|
|
||
| .. code-block:: console | ||
| To create an ``xcdat`` anaconda environment, run: | ||
|
|
||
| >>> conda install -c conda-forge xcdat | ||
| .. code-block:: console | ||
|
|
||
| >>> conda create -n <xcdat> -c conda-forge xcdat | ||
|
|
||
| .. _conda: https://docs.conda.io/en/latest/ |
There was a problem hiding this comment.
My suggestions:
Installation
------------
1. Create a Conda environment from scratch with ``xcdat``
We recommend using the Conda environment creation procedure to install ``xcdat``.
The advantage with following this approach is that Conda will attempt to resolve dependencies (e.g. ``python >= 3.8``) for compatibility.
To create a Conda environment with ``xcdat``, run:
.. code-block:: console
>>> conda create -n <ENV_NAME> -c conda-forge xcdat
>>> conda activate <ENV_NAME>
2. Install ``xcdat`` in an existing Conda environment
You can also install ``xcdat`` in an existing Conda environment, granted that Conda is able to resolve the compatible dependencies.
.. code-block:: console
>>> conda activate <ENV_NAME>
>>> conda install -c conda-forge xcdatThere was a problem hiding this comment.
If the above looks good to you, you can paste it over your edits.
There was a problem hiding this comment.
Also, the first option is technically a Conda environment with xcdat (and other user-specified packages installed), rather than an "xcdat anaconda environment".
docs/getting-started.rst
Outdated
| Installation | ||
| ------------ | ||
|
|
||
| To install ``xcdat`` using `conda`_, run: | ||
| We recommend using the anaconda environment creation procedure to install ``xcdat``. The advantage of following this approach, is that any dependencies (e.g. ``python >= 3.8``) will be resolved during the environment creation. To proceed, run: | ||
|
|
||
| .. code-block:: console | ||
| To create an ``xcdat`` anaconda environment, run: | ||
|
|
||
| >>> conda install -c conda-forge xcdat | ||
| .. code-block:: console | ||
|
|
||
| >>> conda create -n <xcdat> -c conda-forge xcdat | ||
|
|
||
| .. _conda: https://docs.conda.io/en/latest/ |
There was a problem hiding this comment.
Also, the first option is technically a Conda environment with xcdat (and other user-specified packages installed), rather than an "xcdat anaconda environment".
There was a problem hiding this comment.
Thanks for cleaning up my sloppy syntax @tomvothecoder - I can't approve, so over to you guys to tweak as you like
Hopefully this path will avoid some of the dependency issues experienced by Mike W on Perlmutter
@tomvothecoder I hope this is useful
Fix #293