Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update conda install to conda create #294

Merged
merged 4 commits into from
Aug 1, 2022
Merged

update conda install to conda create #294

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2102e24
update conda install to conda create
durack1 Aug 1, 2022
9acbdc4
updated following @tomvothecoder suggestions
durack1 Aug 1, 2022
59c1cb8
Update docs/getting-started.rst
tomvothecoder Aug 1, 2022
104bf3d
Apply suggestions from code review
tomvothecoder Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ Prerequisites
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/
durack1 marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 xcdat

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the above looks good to you, you can paste it over your edits.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the first option is technically a Conda environment with xcdat (and other user-specified packages installed), rather than an "xcdat anaconda environment".