Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 10 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,30 +92,35 @@ Use the `cmi` command-line interface to install and manage modular optional depe
and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps,
known as `profiles`. To use `cmi`, you can run the following example commands:

Show available commands and options,

.. code-block:: bash
:caption: Show available commands and options

cmi -h

List installed and available packs and profiles,

.. code-block:: bash
:caption: List installed and available packs and profiles

cmi pack list
cmi profile list

Show details of a specific pack or profile,

.. code-block:: bash
:caption: Show details of a specific pack or profile

cmi pack show <pack_name>
cmi profile show <profile_name>

Install a pack or profile (by name or path),

.. code-block:: bash
:caption: Install a pack or profile (by name or path)

cmi install <pack_name|profile_name|/absolute/path/to/profile>

List and get installed examples,

.. code-block:: bash
:caption: List and get installed examples

cmi example list
cmi example (copy) <example_name>
Expand Down
59 changes: 58 additions & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,69 @@ Installation

To install ``diffpy.cmi``, create a new conda environment or activate an existing environment and install the package from the conda-forge channel.

.. code-block:: console
.. code-block:: bash

conda create -n diffpy.cmi-env
conda install -c conda-forge diffpy.cmi
conda activate diffpy.cmi-env

To confirm that the installation was successful, type

.. code-block:: bash

python -c "import diffpy.cmi; print(diffpy.cmi.__version__)"

The output should print the latest version.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.cmi_env`` environment, type

.. code-block:: bash

pip install diffpy.cmi

Pack and Profile Installation
-----------------------------

Use the `cmi` command-line interface to install and manage modular optional dependencies, known as `packs`,
and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps,
known as `profiles`. To use `cmi`, you can run the following example commands:

Show available commands and options with,

.. code-block:: bash

cmi -h

List installed and available packs and profiles,

.. code-block:: bash

cmi pack list
cmi profile list

Show details of a specific pack or profile,

.. code-block:: bash

cmi pack show <pack_name>
cmi profile show <profile_name>

Install a pack or profile (by name or path),

.. code-block:: bash

cmi install <pack_name>
cmi install <profile_name>
cmi install </absolute/path/to/profile>

List and get installed examples,

.. code-block:: bash

cmi example list
cmi example (copy) <example_name>

Data and Examples
-----------------
Expand Down
23 changes: 23 additions & 0 deletions news/update-installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Add installation instructions for packs.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading